Pull Request

The Contributing Guide has more details and tips for committing properly.

Review the following checklist to ensure a smooth pull request experience.

  • [ ] Did you squash your changes to a single commit?

  • [ ] Do you need an Apache Jira ticket?Expand for guidance...

    • Yes if your change requires a release note.
    • Yes if your change is a breaking change.
    • No if you change is trivial, such as fixing a typo.
  • [ ] Is this change worthy of a release note? Examples of Release Note-worthy examples...
    • Breaking Changes
    • New, Deprecated, or Removed Languages
    • Security Fixes
    • Significant Refactoring
    • Changing how the product is built
  • [ ] Breaking changes have additional requirements: Expand for instructions...
    • Add or reference an existing Apache Jira THRIFT ticket.
    • Add a Breaking-Change label to the Jira ticket.
    • Add a note to the lib/<language>/README.md file.
    • Add a line to the CHANGES.md file.
  • [ ] Does this change require a build? Expand for guidance...
    • Yes for any code change
    • Yes for any build script change
    • Yes for any docker build environment change
    • Yes for any change affecting the cross test suite
    • No for documentation-only changes
    • No for trivial changes, for example fixing a typo.
      If your change does not require a build, you can add [ci skip] to the end of your commit message.
      This will avoid costly and unnecessary builds in both the pull request and once it is merged.

For more information about committing, see the Contributing Guide.