mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-10-31 02:07:42 +00:00
a95e9e5b4a
Bumps [github.com/containers/common](https://github.com/containers/common) from 0.4.2 to 0.5.0. - [Release notes](https://github.com/containers/common/releases) - [Commits](https://github.com/containers/common/compare/v0.4.2...v0.5.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
202 lines
8.3 KiB
Markdown
202 lines
8.3 KiB
Markdown
|
|
|
|
# Contributing to Buildah
|
|
|
|
We'd love to have you join the community! Below summarizes the processes
|
|
that we follow.
|
|
|
|
## Topics
|
|
|
|
* [Reporting Issues](#reporting-issues)
|
|
* [Submitting Pull Requests](#submitting-pull-requests)
|
|
* [Sign your PRs](#sign-your-prs)
|
|
* [Merge bot interaction](#merge-bot-interaction)
|
|
* [Communications](#communications)
|
|
* [Becoming a Maintainer](#becoming-a-maintainer)
|
|
|
|
## Reporting Issues
|
|
|
|
Before reporting an issue, check our backlog of
|
|
[open issues](https://github.com/containers/buildah/issues)
|
|
to see if someone else has already reported it. If so, feel free to add
|
|
your scenario, or additional information, to the discussion. Or simply
|
|
"subscribe" to it to be notified when it is updated.
|
|
|
|
If you find a new issue with the project we'd love to hear about it! The most
|
|
important aspect of a bug report is that it includes enough information for
|
|
us to reproduce it. So, please include as much detail as possible and try
|
|
to remove the extra stuff that doesn't really relate to the issue itself.
|
|
The easier it is for us to reproduce it, the faster it'll be fixed!
|
|
|
|
Please don't include any private/sensitive information in your issue!
|
|
|
|
## Submitting Pull Requests
|
|
|
|
No Pull Request (PR) is too small! Typos, additional comments in the code,
|
|
new testcases, bug fixes, new features, more documentation, ... it's all
|
|
welcome!
|
|
|
|
While bug fixes can first be identified via an "issue", that is not required.
|
|
It's ok to just open up a PR with the fix, but make sure you include the same
|
|
information you would have included in an issue - like how to reproduce it.
|
|
|
|
PRs for new features should include some background on what use cases the
|
|
new code is trying to address. When possible and when it makes sense, try to break-up
|
|
larger PRs into smaller ones - it's easier to review smaller
|
|
code changes. But only if those smaller ones make sense as stand-alone PRs.
|
|
|
|
Regardless of the type of PR, all PRs should include:
|
|
* well documented code changes
|
|
* additional testcases. Ideally, they should fail w/o your code change applied
|
|
* documentation changes
|
|
|
|
Squash your commits into logical pieces of work that might want to be reviewed
|
|
separate from the rest of the PRs. But, squashing down to just one commit is ok
|
|
too since in the end the entire PR will be reviewed anyway. When in doubt,
|
|
squash.
|
|
|
|
PRs that fix issues should include a reference like `Closes #XXXX` in the
|
|
commit message so that github will automatically close the referenced issue
|
|
when the PR is merged.
|
|
|
|
<!--
|
|
All PRs require at least two LGTMs (Looks Good To Me) from maintainers.
|
|
-->
|
|
|
|
### Sign your PRs
|
|
|
|
The sign-off is a line at the end of the explanation for the patch. Your
|
|
signature certifies that you wrote the patch or otherwise have the right to pass
|
|
it on as an open-source patch. The rules are simple: if you can certify
|
|
the below (from [developercertificate.org](http://developercertificate.org/)):
|
|
|
|
```
|
|
Developer Certificate of Origin
|
|
Version 1.1
|
|
|
|
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
|
660 York Street, Suite 102,
|
|
San Francisco, CA 94110 USA
|
|
|
|
Everyone is permitted to copy and distribute verbatim copies of this
|
|
license document, but changing it is not allowed.
|
|
|
|
Developer's Certificate of Origin 1.1
|
|
|
|
By making a contribution to this project, I certify that:
|
|
|
|
(a) The contribution was created in whole or in part by me and I
|
|
have the right to submit it under the open source license
|
|
indicated in the file; or
|
|
|
|
(b) The contribution is based upon previous work that, to the best
|
|
of my knowledge, is covered under an appropriate open source
|
|
license and I have the right under that license to submit that
|
|
work with modifications, whether created in whole or in part
|
|
by me, under the same open source license (unless I am
|
|
permitted to submit under a different license), as indicated
|
|
in the file; or
|
|
|
|
(c) The contribution was provided directly to me by some other
|
|
person who certified (a), (b) or (c) and I have not modified
|
|
it.
|
|
|
|
(d) I understand and agree that this project and the contribution
|
|
are public and that a record of the contribution (including all
|
|
personal information I submit with it, including my sign-off) is
|
|
maintained indefinitely and may be redistributed consistent with
|
|
this project or the open source license(s) involved.
|
|
```
|
|
|
|
Then you just add a line to every git commit message:
|
|
|
|
Signed-off-by: Joe Smith <joe.smith@email.com>
|
|
|
|
Use your real name (sorry, no pseudonyms or anonymous contributions.)
|
|
|
|
If you set your `user.name` and `user.email` git configs, you can sign your
|
|
commit automatically with `git commit -s`.
|
|
|
|
## Merge bot interaction
|
|
|
|
Maintainers should never merge anything directly into upstream
|
|
branches. Instead, interact with the [bors-ng bot](https://bors.tech/)
|
|
through PR comments as summarized below. This ensures all upstream
|
|
branches contain commits in a predictable order, and that every commit
|
|
has passed automated testing at some point in the past. A
|
|
[Maintainer portal](https://app.bors.tech/repositories/22803)
|
|
is available, showing all PRs awaiting review and approval.
|
|
|
|
### Common [bors-ng comment commands](https://bors.tech/documentation/):
|
|
|
|
(must be on a single comment-line, without any other extraneous text)
|
|
|
|
* `bors r+` - Check the current number of Github Code-review Approvals.
|
|
If the PR has that many approvals or more, the bot will add the PR into
|
|
the queue for testing and possible merging. Both the success criteria
|
|
and minimum approval number are set in the configuration file (see below).
|
|
* `bors retry` - Re-run whatever request was previously issued to the bot. Useful
|
|
when there was a testing flake upon attempted merge.
|
|
* `bors try` - Optional / simulate the actions of `bors r+` (see above) having
|
|
met the minimum number of required approvals. The result will be reported
|
|
back as a comment in the PR, by the bors bot.
|
|
* `bors ping` - Confirm bot is functioning, it will post a comment in the PR if so.
|
|
|
|
|
|
### Interaction/Monitoring
|
|
|
|
Bors-ng relies on the regular branch-testing occurring when it updates the
|
|
special branches ('trying' or 'staging'). Therefore you may use the full
|
|
capabilities available within the CI system. ***Note:*** A single bors-ng
|
|
run may include multiple PRs at once.
|
|
|
|
The easiest way to access a running 'bors try' or 'bors r+' run, is by clicking the
|
|
yellow-circle "status" icon that shows up in an affected PR, for example:
|
|
|
|
|
|
|
|
This will cause a pop-up window to appear with the relevant test-statuses and 'details'
|
|
links available. Since bors-ng will wait for success, as long as one test is still
|
|
running, it's possible to manually re-run any failed tests (e.g. due to flakes).
|
|
|
|
|
|
### Configuration of bors-ng:
|
|
|
|
* The `bors.toml` file in the repository root. This controls
|
|
runtime options for timeouts, blocking labels, and required status names.
|
|
* The [settings page](https://app.bors.tech/repositories/22803/settings).
|
|
This contains mostly security-related and branch-control options.
|
|
|
|
|
|
## Communications
|
|
|
|
For general questions or discussions, please use the
|
|
IRC group on `irc.freenode.net` called `buildah`
|
|
that has been setup.
|
|
|
|
### For discussions around issues/bugs and features:
|
|
|
|
#### Buildah Mailing List
|
|
|
|
You can join the Buildah mailing list by sending an email to `buildah-join@lists.buildah.io` with the word `subscribe` in the subject. You can also go to this [page](https://lists.podman.io/admin/lists/buildah.lists.buildah.io/), then scroll down to the bottom of the page and enter your email and optionally name, then click on the "Subscribe" button.
|
|
|
|
#### GitHub
|
|
You can also use the github
|
|
[issues](https://github.com/containers/buildah/issues)
|
|
and
|
|
[PRs](https://github.com/containers/buildah/pulls)
|
|
tracking system.
|
|
|
|
## Becoming a Maintainer
|
|
|
|
To become a maintainer you must first be nominated by an existing maintainer.
|
|
If a majority (>50%) of maintainers agree then the proposal is adopted and
|
|
you will be added to the list.
|
|
|
|
Removing a maintainer requires at least 75% of the remaining maintainers
|
|
approval, or if the person requests to be removed then it is automatic.
|
|
Normally, a maintainer will only be removed if they are considered to be
|
|
inactive for a long period of time or are viewed as disruptive to the community.
|
|
|
|
The current list of maintainers can be found in the
|
|
[MAINTAINERS](MAINTAINERS) file.
|