How To Contribute
Contributions are welcome to all Apache Accumulo repositories. While most contributions are code, there are other ways to contribute to Accumulo:
- communicate on one of the mailing lists
- view/draft/comment on designs or other docs in Confluence
- review pull requests
- verify and test new releases
- update the Accumulo website and documentation
- report bugs or triage issues
First time developers should start with an issue labeled good first issue.
Any questions/ideas don’t hesitate to contact us.
Accumulo Repositories
| Repository | Links | Description |
|---|---|---|
| Accumulo | Contribute Issues | Core Project |
| Website | Contribute Issues | Source for this website |
| Examples | Contribute Issues | Example code |
| Testing | Contribute Issues | Test suites such as continuous ingest and random walk |
| Docker | Contribute Issues | Source for Accumulo Docker image |
| Wikisearch | Contribute Issues | Example application that indexes and queries Wikipedia data |
| Proxy | Issues | Apache Thrift service that exposes Accumulo to other languages |
| Maven plugin | Issues | Maven plugin that runs Accumulo |
| Classloaders | Issues | Apache Accumulo Classloader Extras |
| Access | Issues | Apache Accumulo Access Control Library |
Example Contribution workflow
- Create a GitHub account for issues and pull requests.
- Find an issue to work on or optionally create one that describes the work that you want to do.
- Fork and clone the GitHub repository that you want to contribute to.
- Create a branch in the local clone of your fork.
git checkout -b accumulo-4321 - Do work and commit to your branch. You can reference this link for a guide on how to write good commit log messages.
- Ensure your branch builds cleanly using the command:
mvn clean verify -DskipITs - If needed, squash to the minimum number of commits. For help on squashing commits, see this tutorial or StackOverflow answer.
- Push your branch to your fork.
git push origin accumulo-4321 - Create a Pull Request on GitHub to the appropriate repository. A draft pull request can be used if the work is not complete.
- At least one committer (and others in the community) will review your pull request and add any comments to your code.
- 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.
- Repeat this process until a reviewer approves the pull request.
- 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
- Accumulo follows semver for its public API.
- Every file requires the ASF license header as described in ASF Source Header.
- Do not use Author Tags. The code is developed and owned by the community.
Helpful Links
- Build resources - Jenkins
- Releases - Making a release, Verifying a release
- Confluence - Accumulo Confluence Space provides a collaboration space for design documents. If you require write access, please contact us with your Confluence username and request details.
For more information, see the contributor guide.