accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <>
Subject [GitHub] ctubbsii commented on a change in pull request #36: Updated contributor guide
Date Thu, 01 Jan 1970 00:00:00 GMT
ctubbsii commented on a change in pull request #36: Updated contributor guide

 File path: pages/
 @@ -0,0 +1,151 @@
+title: How To Contribute
+permalink: /how-to-contribute/
+redirect_from: /contributor/
+Contributions are welcome to all Apache Accumulo repositories. While most contributions are
+there are other ways to contribute to Accumulo:
+* answer questions on mailing lists
+* review pull requests
+* verify and test new releases
+* update the Accumulo website and documentation
+This document describes how to make contributions which are reviewed (via GitHub pull requests)
+the community before being merged by a committer.
+## Issues
+Any contribution should have a corresponding issue. Accumulo uses [JIRA] for issue tracking.
Before creating an issue,
+you will need to create an [Apache JIRA account][jira-signup]. If you need help finding an
issue to work on, check out
+the [open issues labeled for newbies][newbie-issues] or [contact us][contact].
+## Repositories
+Contributions can be made to the following repositories. While the general contribution workflow
+described below, repositories have special instructions in their `` file which
can be
+viewed by clicking on the `C` in the Links column below.
+| Repository                      | Links    | Description
+| ------------------------------- | -------- | -----------
+| [Accumulo][a]                   | [C][ac]  | Core Project
+| [Accumulo Website][w]           | [C][wc]  | Source for this website
+| [Accumulo Examples][e]          | [C][ec]  | Accumulo example code
+| [Accumulo Testing][t]           | [C][tc]  | Accumulo test suites such as continuous ingest
and random walk
+| [Accumulo Docker][d]            | [C][dc]  | Source for Accumulo Docker image
+| [Accumulo Wikisearch][s]        | [C][sc]  | Accumulo example application that indexes
and queries Wikipedia data
+## Contribution workflow
+1. Create an [Apache JIRA account][jira-signup] (for issue tracking) and [GitHub account][github-join]
(for pull requests).
+1. Find an [issue][newbie-issues] to work on or create one that describes the work that you
want to do.
+1. [Fork] and [clone] the GitHub repository that you want to contribute to.
+1. Create a branch in the local clone of your fork.
+    ```
+    git checkout -b accumulo-4321
+    ```
+1. Do work and commit to your branch
+1. Ensure you works satisfies the guidelines laid out in the `` file.
+1. If needed, squash to the minimum number of commits. For help on squashing commits, see
this tutorial or StackOverflow answer.
+1. [Push] your branch to your fork.
+    ```
+    git push origin fluo-301
+    ```
+1. Create a [Pull Request] on GitHub to the appropriate repository. If the work is not complete
and the Pull Request is for feedback, please put `[WIP]` in the subject.
+1. At least one committer (and others in the community) will review your pull request and
add any comments to your code.
+1. Push any changes from the review to the branch as new commits so the reviewer only needs
to review new changes. Please avoid squashing commits after the review starts. Squashing makes
it hard for the reviewer to follow the changes.
+1. Repeat this process until a reviewer approves the pull request.
+1. When the review process is finished, all commits on the pull request may be squashed by
a committer. Please avoid squashing as it makes it difficult for the committer to know if
they are merging what was reviewed.
+## Coding Guidelines
+* If a change needs to go into multiple branches of Accumulo, it should be merged into earlier
branches then later branches. 
+* Accumulo follows [semver] for its public API. Accumulo lists which packages are public
API in its [][accumulo-readme]. 
+* Every file requires the ASF license header as described in [ASF Source Header][srcheaders].
+* Remove all trailing whitespaces. Eclipse users can use Source&rarr;Cleanup option to
accomplish this.
+* Use 2 space indents and never use tabs!
+* Use 160-column line width for Java code and Javadoc.
+* Use a new line with single statement if/else blocks.
+* Do not use Author Tags. The code is developed and owned by the community.
+## Code Editors
+Feel free to use any editor when contributing Accumulo. If you are looking for a recommendation,
most Accumulo
 Review comment:
   I don't know if "most" is accurate here. "many" certainly is.

This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:

With regards,
Apache Git Services

View raw message