Contributing to Apache Software Foundation Parent POM

Have you found a bug or have an idea for a cool new feature? Contributing code is a great way to give something back to the open source community. Before you dig right into the code, there are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Getting Started

• Make sure you have a GitHub account.
• If you’re planning to implement a new feature, please discuss your changes on the developer mailing list first. This way you can make sure you’re not wasting your time on something that isn’t considered to be in Apache Maven’s scope.
• Submit a ticket for your issue, assuming one does not already exist.
  • Clearly describe the issue, including steps to reproduce when it is a bug.
  • Make sure you fill in the earliest version that you know has the issue.
• Fork the repository on GitHub.

Making and Submitting Changes

We accept Pull Requests via GitHub. The developer mailing list is the main channel of communication for contributors.
There are some guidelines which will make applying PRs easier for us:

• Create a topic branch from where you want to base your work (this is usually the master branch). Push your changes to a topic branch in your fork of the repository.
• Make commits of logical units.
• Respect the original code style: by using the same codestyle, patches should only highlight the actual difference, not being disturbed by any formatting issues:
  • Only use spaces for indentation.
  • Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted, create a separate PR for this change.
  • Check for unnecessary whitespace with git diff --check before committing.
• Make sure your commit messages are in the proper format. Your commit message should contain the key of the issue.

[#issue-number] - Subject of the issue
 Optional supplemental description.

• Update the site documentation accordingly in docs/src/site and build it via mvn site -f docs
• Submit a pull request to the repository in the Apache organization.

If you plan to contribute on a regular basis, please consider filing a contributor license agreement.

Making Trivial Changes

For changes of a trivial nature to comments and documentation, or other simple changes it is not always necessary to create a new issue.
In this case, it is appropriate to skip the issue from a commit message.

Additional Resources

• Contributing patches
• Contributor License Agreement
• General GitHub documentation
• GitHub pull request documentation
• Apache Maven Twitter Account