Depending on your changes there are certain rules you have to follow if you expect your Pull Request to be merged.

Note: It is recommended to create a new remote branch for each Pull Request. Based on the current development changes!

Documentation Changes: If you only adjust documentation and no code you should instead use the docs/development branch! This branch exists to avoid making releases for every minor typo change in the documentation.

1. Adding a new Method or Class

   • If your addition is not internal (e.g. an impl class or private method) you have to write documentation.
     • For that please follow the JavaDoc template
   • Keep your code consistent! example
     • Follow the guides provided at JDA Structure Guide
     • Compare your code style to the one used all over JDA and ensure you do not break the consistency (if you find issues in the JDA style you can include and update it)
   • Do not remove existing functionality, use deprecation instead (for reference deprecation policy)

2. Making a Commit

   • While having multiple commits can help the reader understand your changes, it might sometimes be better to include more changes in a single commit.
   • When you commit your changes write a proper commit caption which explains what you have done

3. Updating your Fork

   • Before you start committing make sure your fork is updated. (See Syncing a Fork or Keeping a Fork Updated)

4. Only open Pull Requests to feature/experimental/development

   • Look at the Repository Structure for further details

For more information please consult the Contributing section of our wiki.