Repository: accumulo Updated Branches: refs/heads/ACCUMULO-4647 [created] 8b6e8330c
ACCUMULO-4647 - start of contributor guide Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/8b6e8330 Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/8b6e8330 Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/8b6e8330 Branch: refs/heads/ACCUMULO-4647 Commit: 8b6e8330cc17216f40198f3d22453b5a8405ea1f Parents: 66178ad Author: Dave Marion <dlmar...@apache.org> Authored: Tue Jun 6 09:00:43 2017 -0400 Committer: Dave Marion <dlmar...@apache.org> Committed: Tue Jun 6 09:00:43 2017 -0400 ---------------------------------------------------------------------- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ pom.xml | 1 + 2 files changed, 26 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/accumulo/blob/8b6e8330/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b32729e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributors Guide + + If you believe that you have found a bug, please search for an existing [issue](https://issues.apache.org/jira/browse/accumulo) to see if it has already been reported. If you would like to add a new feature to Accumulo, please send an email with your idea to the [user](mailto:u...@accumulo.apache.org) mail list. If it's appropriate, then we will create a ticket and assign it to you. + +## Development + +- Ensure that your work targets the correct branch +- Add / update unit and integration tests +- Ensure that Accumulo builds cleanly using the command: `mvn clean verify` + +## Patch Submission + +- Before submission please squash your commits using a message that contains the JIRA issue number and a description of the changes. +- Patches should be submitted in the form of Pull Requests to the Apache Accumulo GitHub [repository](https://github.com/apache/accumulo/) or to the [Review Board](https://reviews.apache.org) accumulo repository. + +## Review + +- One or more committers will review your patch. +- They will be looking for things like threading issues, performance implications, API design, etc. +- Reviewers will likely ask questions to better understand your change - be prepared to answer them. +- Reviewers will make comments about changes to your patch: + - MUST means that the change is required + - SHOULD means that the change is suggested, further discussion on the subject may be required + - COULD means that the change is optional + http://git-wip-us.apache.org/repos/asf/accumulo/blob/8b6e8330/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 69b4e77..f4c067e 100644 --- a/pom.xml +++ b/pom.xml @@ -832,6 +832,7 @@ <exclude>nbproject/**</exclude> <exclude>nb-configuration.xml</exclude> <exclude>nbactions.xml</exclude> + <exclude>CONTRIBUTING.md</exclude> </excludes> </configuration> </plugin>