technofab/zfs-localpv
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/zfs-localpv.git synced 2025-12-12 06:20:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(doc): add contributing checkout list (#138)

Browse source 
Signed-off-by: wiwen <shenggxhz@gmail.com>
This commit is contained in:
wiwen 2020-06-01 12:28:33 +08:00 • committed by GitHub
parent 42ed7d85ee
commit 307861282a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

1
CONTRIBUTING.md
View file

@ -26,6 +26,7 @@ ZFS-LocalPV is an Apache 2.0 Licensed project and all your commits should be sig
* Rebase to the current master branch before submitting your pull request. * Rebase to the current master branch before submitting your pull request.
* Commits should be as small as possible. Each commit should follow the checklist below: * Commits should be as small as possible. Each commit should follow the checklist below:
- For code changes, add tests relevant to the fixed bug or new feature. - For code changes, add tests relevant to the fixed bug or new feature.
- Before committing your code, make sure you have run `make format` and `make manifests`, to format the code and autogenerate the CRDs yaml.
- Pass the compile and tests - includes spell checks, formatting, etc. - Pass the compile and tests - includes spell checks, formatting, etc.
- Commit header (first line) should convey what changed and it should follow the commit [guideline](https://github.com/openebs/openebs/blob/master/contribute/git-commit-message.md) - Commit header (first line) should convey what changed and it should follow the commit [guideline](https://github.com/openebs/openebs/blob/master/contribute/git-commit-message.md)
- Commit body should include details such as why the changes are required and how the proposed changes help - Commit body should include details such as why the changes are required and how the proposed changes help