Skip to content
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

add contributing checkout list #138

Merged
merged 2 commits into from
Jun 1, 2020
Merged

add contributing checkout list #138

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8496e22
add contributing checkout list
Icedroid May 29, 2020
f69cbbb
fix contributing check list
Icedroid Jun 1, 2020
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
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,16 @@ ZFS-LocalPV is an Apache 2.0 Licensed project and all your commits should be sig
## Pull Request Checklist
* 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:
- 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 commit your code, make sure you have run `make format`.
- 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 body should include details such as why the changes are required and how the proposed changes help
- DCO Signed
- DCO Signed
* if you have changed crd(comment or anything), then run make manifests to generate the crds as they are auto generated. So you need to do two things:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we remove this line and append make manifests with make format in the above line (line 29).

Before committing your code, make sure you have run make format and make manifests, to format the code and autogenerate the CRDs yaml.

- `make format` <==== for formatting
- `make manifests` <==== for crd changes
And then add the unstaged files and push.
* If your PR is not getting reviewed or you need a specific person to review it, please reach out to the OpenEBS Contributors. See [OpenEBS Community](https://github.com/openebs/openebs/tree/master/community)

## Sign your work
Expand Down