Skip to content
This repository was archived by the owner on Aug 13, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (19 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

27 lines (19 loc) · 1.87 KB
Raw

##Contributing

This repo's maintainers are engineers at Basho and welcome your contribution to this project.

How-to contribute to the Java client

IMPORTANT: This is an open source project licensed under the Apache 2.0 License. We encourage contributions to the project from the community. We ask that you keep in mind these considerations when planning your contribution.

  • Whether your contribution is for a bug fix or a feature request, create an issue and let us know what you are thinking.
  • For bugs, if you have already found a fix, feel free to submit a Pull Request referencing the Issue you created.
  • For feature requests, we want to improve upon the library incrementally which means small changes at a time. In order ensure your PR can be reviewed in a timely manner, please keep PRs small, e.g. <10 files and <500 lines changed. If you think this is unrealistic, then mention that within the Issue and we can discuss it.
  • For help on running Integration tests, please see the README section on this subject.

Pull Request Process

Here’s how to get started:

  • Create an issue that explains the bug or new feature.
  • Fork the appropriate sub-projects that are affected by your change.
  • Create a topic branch for your change and checkout that branch. git checkout -b some-topic-branch
  • Make your changes and run the test suite.
  • Commit your changes and push them to your fork.
  • Open pull-requests for the appropriate projects.
  • Contributors will review your pull request, suggest changes, and merge it when it’s ready and/or offer feedback.

You can read the full guidelines for bug reporting and code contributions on the Riak Docs.