Skip to content

Contributing

In this page, you will find some guidelines on contributing to Apache Ranger.

If you are thinking of contributing but first would like to discuss the change you wish to make, we welcome you to raise a Jira Issue. You can also subscribe to the Dev List and join us on Slack to connect with the community.

The Ranger Project is hosted on GitHub at https://github.com/apache/ranger.

The Ranger community prefers to receive contributions as Github pull requests.

View open pull requests

When you are ready to submit your pull request, please keep the following in mind:

  • PRs should be associated with a Jira Issue
  • PRs should include a clear and descriptive title and summary of the change
  • Please ensure that your code adheres to the existing coding style
  • Please ensure that your code is well tested
  • Please ensure that your code is well documented

Review Board legacy

The Review Board may be used for Ranger code reviews as well.

To submit a patch for review, please follow these steps:

  • Create a Jira Issue for the change you wish to make.
  • Create a patch file using git format-patch or git diff > my_patch.patch.
  • Upload the patch to Review Board and associate it with the Jira issue you created earlier.
  • Request a review from the Ranger committers.
  • Address any feedback you receive and update the patch as necessary.
  • Once your patch has been approved, a committer will merge it into the main codebase.
  • Close the associated Jira issue.