accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dlmar...@apache.org
Subject accumulo git commit: ACCUMULO-4647: Added contributor guide
Date Tue, 06 Jun 2017 16:13:45 GMT
Repository: accumulo
Updated Branches:
  refs/heads/master 66178ad87 -> 39efb48d0


ACCUMULO-4647: Added contributor guide


Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/39efb48d
Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/39efb48d
Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/39efb48d

Branch: refs/heads/master
Commit: 39efb48d06e4f3955726a1b8fb401fdc2bcfb5d9
Parents: 66178ad
Author: Dave Marion <dlmarion@apache.org>
Authored: Tue Jun 6 12:13:09 2017 -0400
Committer: Dave Marion <dlmarion@apache.org>
Committed: Tue Jun 6 12:13:09 2017 -0400

----------------------------------------------------------------------
 CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo/blob/39efb48d/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..9f52bdb
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,43 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# 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 [dev](mailto:dev@accumulo.apache.org) mail list.
If it's appropriate, then we will create a ticket and assign it to you.
+
+## Development
+
+- See the [Developer's Guide](https://accumulo.apache.org/contributor/source) for information
regarding common build commands, IDE setup and more.
+- Ensure that your work targets the correct branch
+- Add / update unit and integration tests
+
+## Patch Submission
+
+- Ensure that Accumulo builds cleanly before submiting your patch using the command: `mvn
clean verify -DskipITs`
+- Before submission please squash your commits using a message that starts with 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
+
+- We welcome reviews from anyone. Any committer can approve and merge the changes.
+- Reviewers will be looking for things like threading issues, performance implications, API
design, etc.
+- Reviewers will likely ask questions to better understand your change.
+- 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
+


Mime
View raw message