Skip to content

Latest commit

 

History

History
86 lines (61 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

86 lines (61 loc) · 3.49 KB

How to contribute to Apache Arrow Java

Did you find a bug?

The Arrow Java project uses GitHub as a bug tracker. To report a bug, sign in to your GitHub account, navigate to GitHub issues and click on New issue .

Before you create a new bug entry, we recommend you first search among existing Arrow issues in GitHub.

Did you write a patch that fixes a bug or brings an improvement?

  • Create a GitHub issue and submit your changes as a GitHub Pull Request.
  • Reference the issue in your PR description.
  • Add one or more of the labels "bug-fix", "chore", "dependencies", "documentation", and "enhancement" to your PR as appropriate.
    • "bug-fix" is for PRs that fix a bug.
    • "chore" is for other administrative work (build system, release process, etc.).
    • "dependencies" is for PRs that upgrade a dependency. (Usually only used by dependabot.)
    • "documentation" is for documentation updates.
    • "enhancement" is for PRs that add new features.
  • Add the "breaking-change" label to your PR if there are breaking API changes.
  • Add the PR title. The PR title will be used as the eventual commit message, so please make it descriptive but succinct.

Example #1:

GH-12345: Document the pull request process

Explain how to open a pull request and what the title, body, and labels should be.

Closes #12345.

Example #2:

GH-42424: Expose Netty server builder in Flight

Allow direct usage of gRPC APIs for low-level control.

Closes #42424.

Minor Fixes

Any functionality change should have a GitHub issue opened. For minor changes that affect documentation, you do not need to open up a GitHub issue. Instead you can prefix the title of your PR with "MINOR: " if it meets one of the following:

  • Grammar, usage and spelling fixes that affect no more than 2 files
  • Documentation updates affecting no more than 2 files and not more than 500 words.

Do you want to propose a significant new feature or an important refactoring?

We ask that all discussions about major changes in the codebase happen publicly on the arrow-dev mailing-list.

Do you have questions about the source code, the build procedure or the development process?

You can also ask on the mailing-list, see above.

Further information

Please read our development documentation or look through the New Contributor's Guide.