-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CONTRIBUTING.md and k8s PR template
We now use the Kubernetes PR template to better integrate with prow. This links to a CONTRIBUTING.md, which is now also part of this repository. Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
- Loading branch information
1 parent
4227889
commit d2aabc7
Showing
2 changed files
with
210 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
<!-- Thanks for sending a pull request! | ||
Please be aware that we're following the Kubernetes guidelines of contributing | ||
to this project. This means that we have to use this mandatory template for all | ||
of our pull requests. | ||
Please also make sure you've read and understood our contributing guidelines | ||
(https://github.com/containers/oci-spec-rs/blob/main/CONTRIBUTING.md) as well as | ||
ensuring that all your commits are signed with `git commit -s`. | ||
Here are some additional tips for you: | ||
- If this is your first time, please read our contributor guidelines: | ||
https://git.k8s.io/community/contributors/guide#your-first-contribution and | ||
developer guide | ||
https://git.k8s.io/community/contributors/devel/development.md#development-guide | ||
- Please label this pull request according to what type of issue you are | ||
addressing, especially if this is a release targeted pull request. For | ||
reference on required PR/issue labels, read here: | ||
https://git.k8s.io/community/contributors/devel/sig-release/release.md#issuepr-kind-label | ||
- If you want *faster* PR reviews, read how: | ||
https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews | ||
- If the PR is unfinished, see how to mark it: | ||
https://git.k8s.io/community/contributors/guide/pull-requests.md#marking-unfinished-pull-requests | ||
--> | ||
|
||
#### What type of PR is this? | ||
|
||
<!-- | ||
Uncomment only one `/kind <>` line, hit enter to put that in a new line, and | ||
remove leading whitespace from that line: | ||
--> | ||
|
||
<!-- | ||
/kind api-change | ||
/kind bug | ||
/kind ci | ||
/kind cleanup | ||
/kind dependency-change | ||
/kind deprecation | ||
/kind design | ||
/kind documentation | ||
/kind failing-test | ||
/kind feature | ||
/kind flake | ||
/kind other | ||
--> | ||
|
||
#### What this PR does / why we need it: | ||
|
||
#### Which issue(s) this PR fixes: | ||
|
||
<!-- | ||
Automatically closes linked issue when PR is merged. | ||
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`. | ||
--> | ||
|
||
<!-- | ||
Fixes # | ||
or | ||
None | ||
--> | ||
|
||
#### Special notes for your reviewer: | ||
|
||
#### Does this PR introduce a user-facing change? | ||
|
||
<!-- | ||
If no, just write `None` in the release-note block below. If yes, a release note | ||
is required: Enter your extended release note in the block below. If the PR | ||
requires additional action from users switching to the new release, include the | ||
string "action required". | ||
For more information on release notes see: | ||
https://git.k8s.io/community/contributors/guide/release-notes.md | ||
--> | ||
|
||
```release-note | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
# Contributing to oci-spec-rs | ||
|
||
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) | ||
- [Communications](#communications) | ||
|
||
## Reporting Issues | ||
|
||
Before reporting an issue, check our backlog of | ||
[open issues](https://github.com/containers/oci-spec-rs/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 test cases, 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. | ||
|
||
Test your changes by running: | ||
|
||
```console | ||
$ make clippy | ||
``` | ||
|
||
And you can run the test suite if you have access to elevated permissions: | ||
|
||
```console | ||
# cargo test | ||
``` | ||
|
||
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. | ||
|
||
Most PRs will be reviewed by the [OWNERS](OWNERS). | ||
|
||
### 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: John Doe <john.doe@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`. | ||
|
||
## Communications | ||
|
||
For discussions around issues/bugs and features, you can use the GitHub | ||
[issues](https://github.com/containers/oci-spec-rs/issues) and | ||
[PRs](https://github.com/containers/oci-spec-rs/pulls) tracking system. |