Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Provide Patches: We encourage you to assign the relevant JIRA issue to yourself and supply a patch for it. The patch you provide can be codedocumentationbuild changes, or any combination of these. More information on this is available in the following sections.

Documentation: Contribute to the Sentry documentation by adding descriptions of new features, updating outdated documentation, and filling in documentation gaps. 

Providing Patches

In order to provide patches, follow these guidelines:

...

  • How to create a patch file:
    • The preferred naming convention for Sentry patches is SENTRY-12345.patch, or SENTRY-12345.001.patch where 12345 is the JIRA number. You might want to name successive versions of the patch something like SENTRY-12345.002.patch, SENTRY-12345.003.patch, etc. as you iterate on your changes based on review feedback and re-submit them.
    • If the patch is targeted for other branch, the patch name should be followed by "-" and the branch nameSENTRY-<JIRA number>.<patch version>-<branch name>, for example: SENTRY-12345.001-branch1.patch
    • The command to generate the patch is "git diff". Example:

      Code Block
      $ git diff > /path/to/SENTRY-1234.001.patch
       
      for Branch
      $ git diff > /path/to/SENTRY-1234.001-branch1.patch
    • Read the patch file. Make sure it includes ONLY the modifications required to fix a single issue.

...

If a change has met all your criteria for review, please +1 the change to indicate that you are happy with it.

Stay involved

Contributors should join the Sentry mailing lists. In particular, the commits@sentry.incubator.apache.org list (to see changes as they are made), the dev@sentry.incubator.apache.org list (to join discussions of changes).

See Also

Disclaimer

Contributing to the Documentation

Before you edit the Sentry documentation, create a JIRA with the Docs component to track documentation changes. Request access to this wiki from the Sentry PMC and make the required changes. There is no formal review process for the wiki, but it is always a good idea to have the documentation reviewed before closing the JIRA. 

Stay involved

Contributors should join the Sentry mailing lists. In particular, the commits@sentry.apache.org list (to see changes as they are made), the dev@sentry.apache.org list (to join discussions of changes).


See Also

 Apache Sentry is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache TLP sponsor. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.