Contributing to appNG
First of all, we would like to thank you for your interest and commitment to contribute to and improve appNG.
Respect our Code of Conduct: https://github.com/appNG/appng/blob/master/CODE_OF_CONDUCT.adoc
Create a ticket at https://appng.org/jira
Fork and clone the repository
Create a branch. Usually the branch should be based on the master branch. If you are sure your changes will be applied to a development branch, base your feature branch on that development branch. Use the ticket number as branch name (e.g.
Apply the license header (https://github.com/appNG/appng/blob/master/license-header.txt)
Add yourself as author (
@author) for significant changes
Usually, you should retain the original author of the file, unless you did a complete rewrite of the file in question.
Provide a unit test covering your changes
Code style / source code formatting
Unix line endings
All files should be UTF-8 encoded
Line breaks after 120 characters
Format source code and organize imports (useful: Eclipse Preferences - Java - Editor - Save Actions - Format source code and Organize imports)
Build appNG using the following command:
mvn clean install -Djavax.xml.accessExternalSchema=all
The build must complete with a
BUILD SUCCESS message.
Make sure you configured
user.emailappropriately in your
Update your local branch with the latest changes from the base branch. Avoid merge commits (e.g.
git config --global branch.autosetuprebase alwaysor
git pull --rebase).
Prefix your commit message with the (main) ticket number. Further ticket numbers may be mentioned in the commit message, if appropriate. The commit message should at least equal the ticket name. If there are multiple commits to the same ticket, describe what you changed with the current commit.
Update the documentation (Javadoc, README, and user documentation, if necessary)
Submit a pull request. Use the ticket id and name as title for the pull request.