From 8496e22d1d545d9271d7b901e423105f35f170e9 Mon Sep 17 00:00:00 2001 From: wiwen Date: Fri, 29 May 2020 09:06:43 +0800 Subject: [PATCH 1/2] add contributing checkout list Signed-off-by: wiwen --- CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0dc8b5092..0751599c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: + - `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 From f69cbbbb489b31d8ac4f7e34ebf2a1a64c9699e8 Mon Sep 17 00:00:00 2001 From: wiwen Date: Mon, 1 Jun 2020 11:34:33 +0800 Subject: [PATCH 2/2] fix contributing check list Signed-off-by: wiwen --- CONTRIBUTING.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0751599c9..16cfb66f2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,15 +26,11 @@ 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. * 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. - - Before commit your code, make sure you have run `make format`. + - 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. - 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 -* 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: - - `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