Skip to content

docs: fix typos in CONTRIBUTING.md #1796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
immanuwell wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −6
Open

docs: fix typos in CONTRIBUTING.md #1796

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ When writing a bug report:

# Making Suggestions

Toolbx is not feature-complete and some of it's functionality is not-there-yet.
Toolbx is not feature-complete and some of its functionality is not there yet.
We are thankful for all suggestions and ideas but be ready that your suggestion
may be rejected.

Expand Down Expand Up @@ -73,7 +73,7 @@ When writing a suggestion:
# First Contribution

Toolbx is written in [Go](https://golang.org) and uses [Meson](https://mesonbuild.com)
as it's buildsystem.
as its build system.

Instructions for building Toolbx from source are in our [README](https://github.com/containers/toolbox/blob/main/README.md).

Expand All @@ -94,7 +94,7 @@ Here are some ideas of what you could contribute with:
own. **Beware**, maintainers still don't have a clear idea of how the image
infrastructure should look like.
- Write documentation - Some functions in Toolbx's code don't have comments and
it's not very clear what they do. Toolbx has it's [documentation](https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/)
it's not very clear what they do. Toolbx has its [documentation](https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/)
hosted by Fedora. It's not very large and could use some attention.
- Hack on the code and share the result - Seriously! Sometimes random ideas are
the best.
Expand Down Expand Up @@ -122,7 +122,7 @@ documentation, code comments and much more.

## After Creating a Pull Request

It may take the us some time to review your changes and sometimes even longer to
It may take us some time to review your changes and sometimes even longer to
actually merge them. Please, don't interpret this as an act of not appreciating
your efforts! We really appreciate them! Sometimes we may be stuck in different
parts of our lives.
Expand All @@ -133,7 +133,7 @@ try to @ping us at our communication channels (see section #Communication).
##
Toolbx has a CI (Continuous Integration) setup for running tests. Their goal is to check if your
changes don't affect adversely Toolbx's functionality. Sometimes these tests
mail fail with a false-positive. If you are not sure about the outcome of the
may fail with a false positive. If you are not sure about the outcome of the
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!

Toolbx'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).
Expand Down Expand Up @@ -161,4 +161,4 @@ something wrong.

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.
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.