containers
/
toolbox
mirror of https://github.com/containers/toolbox.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING: Update content 

GitHub generates a table of content[0] for markdown documents using the
headings so there's no need to maintain it manually anymore.

There is a new Matrix chat room[1] for getting in touch with the Toolbx
developers. Advertise it instead of the alternatives.

We have new gifs from jimmac, let's use them!

https://github.com/containers/toolbox/pull/939

[0] https://github.blog/changelog/2021-04-13-table-of-contents-support-in-markdown-files
[1] https://matrix.to/#/#toolbx:matrix.org
This commit is contained in:
Ondřej Míchal 2021-11-30 23:23:34 +02:00
parent 6e47e1f4f7
commit b14d623f21
1 changed files with 13 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
CONTRIBUTING.md
View File

@ -1,26 +1,10 @@
![Toolbox logo](data/logo/toolbox-logo-landscape.svg) ![Toolbox logo](data/gfx/powerup.gif)
# Contributing to Toolbox # Contributing to Toolbox
Thank you for wanting to contribute to Toolbox! We greatly appreciate your Thank you for wanting to contribute to Toolbox! We greatly appreciate your
interest! interest!
# Table of contents
- [Contributing to Toolbox](#contributing-to-toolbox)
- [Table of contents](#table-of-contents)
- [Reporting Bugs](#reporting-bugs)
- [Before Submiting a Bug Report](#before-submiting-a-bug-report)
- [Writing a Bug Report](#writing-a-bug-report)
- [Making Suggestions](#making-suggestions)
- [Before Submitting a Suggestion](#before-submitting-a-suggestion)
- [Writing a Suggestion](#writing-a-suggestion)
- [First Contribution](#first-contribution)
- [Pull Requests](#pull-requests)
- [Creating a Pull Request](#creating-a-pull-request)
- [After Creating a Pull Request](#after-creating-a-pull-request)
- [Little Style Guide](#little-style-guide)
# Reporting Bugs # Reporting Bugs
## Before Submitting a Bug Report ## Before Submitting a Bug Report
@ -36,9 +20,7 @@ interest!
- See our [documentation](https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/) - See our [documentation](https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/)
if there are some steps that could help you solve your issue if there are some steps that could help you solve your issue
- Sometimes a bug is not reported in our bug tracker but instead people ask for - Sometimes a bug is not reported in our bug tracker but instead people ask for
help somewhere else: IRC ([Freenode](https://freenode.net) - #silverblue, help somewhere else (e.g., chat channels). In such cases we'd like you to still report the bug and
#containers, #fedora, #fedora-devel,..), [Fedora forum](https://discussion.fedoraproject.org/tag/toolbox),
or somewhere else. In such cases we'd like you to still report the bug and
share with us any info that could be gathered from those places share with us any info that could be gathered from those places
## Writing a Bug Report ## Writing a Bug Report
@ -136,6 +118,7 @@ documentation, code comments and much more.
directory `doc`. If your changes affect Toolbox's [documentation](https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/), directory `doc`. If your changes affect Toolbox's [documentation](https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/),
consider creating a PR there (but to save yourself time, you can do it consider creating a PR there (but to save yourself time, you can do it
after your changes are accepted), too. after your changes are accepted), too.
- After creating a PR add to the bottom of all your commits a link to the PR. This helps the future maintainers find discussions around the changes.
## After Creating a Pull Request ## After Creating a Pull Request
@ -145,16 +128,15 @@ your efforts! We really appreciate them! Sometimes we may be stuck in different
parts of our lives. parts of our lives.
If it takes us a very long time to even respond to your Pull Request, you can If it takes us a very long time to even respond to your Pull Request, you can
try to @ping us, request a review or try to reach to us on IRC ([Freenode](https://freenode.net/); try to @ping us at our communication channels (see section #Communication).
#silverblue, #containers, #fedora-devel,..) or [Fedora Forum](https://discussion.fedoraproject.org).
Toolbox has a simple CI (Continuos Integration) setup for running system tests ( ##
can be found under directory `test/system`). Their goal is to check if your Toolbox has a CI (Continuous Integration) setup for running tests. Their goal is to check if your
changes don't affect adversely Toolbox's functionality. Sometimes these tests changes don't affect adversely Toolbox's functionality. Sometimes these tests
mail fail with a false-positive. If you are not sure about the outcome of the mail fail with a false-positive. If you are not sure about the outcome of the
tests, reach out to the maintainers! tests, you can try to trigger a new test run by writing a comment with text `recheck` (really just that). If the issue persists, reach out to the maintainers!
Toolbox's CI system is [Zuul](https://zuul-ci.org/) hosted at [softwarefactory](https://softwarefactory-project.io/). Toolbox's CI system is [Zuul](https://zuul-ci.org/) hosted at [softwarefactory](https://softwarefactory-project.io/). The CI is defined using [Ansible](https://www.ansible.com) playbooks. For more information on writing Zuul jobs see their [documentation](https://zuul-ci.org/docs/zuul/reference/user.html).
# Little Style Guide # Little Style Guide
@ -175,3 +157,8 @@ If you are using Visual Studio Code, there are [plugins](https://marketplace.vis
that include all this functionality and throw a warning if you're doing that include all this functionality and throw a warning if you're doing
something wrong. something wrong.
# Communication
The Toolbx team hangs-out at a dedicated Matrix channel: [#toolbx:matrix.org](https://matrix.to/#/#toolbx:matrix.org).
For Fedora-specific discussions you can visit their [wiki](https://docs.fedoraproject.org/en-US/project/join/) to learn about the means to contact the community.