PlaceholderAPI/.github/CONTRIBUTING.md

27 lines
1.4 KiB
Markdown
Raw Normal View History

2019-06-02 20:06:56 +02:00
[issue]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_placeholderapi.md
[Discord]: https://helpch.at/discord
2019-06-02 19:56:33 +02:00
# Contributing
When contributing to this repository, please first discuss the change you wish to make via [issue] or through [Discord] with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
## Pull Request Process
2020-07-31 15:24:07 +02:00
When creating a Pull request should you follow the below rules:
2019-06-02 19:56:33 +02:00
2020-07-31 15:24:07 +02:00
- When pushing towards the code of PlaceholderAPI make the Pull request target the `develop` branch of this repository.
- When pushing towards the wiki (Towards the dedicated Wiki folder) make the Pull request target the `docs/wiki` branch of this repository.
- Any Pull requests targeting the `master` branch for above reasons will be denied and closed.
2019-06-02 19:56:33 +02:00
2020-07-31 15:24:07 +02:00
### Code structure
When changing the code of PlaceholderAPI should you follow these basic guidelines for how to do stuff.
2019-06-02 19:56:33 +02:00
2020-07-31 15:24:07 +02:00
#### Codestyle
We follow the Google Codestyle for the project. Please make sure that you follow it when contributing code to this project.
2019-06-02 19:56:33 +02:00
2020-07-31 15:24:07 +02:00
#### Documentation
When you implement/change methods that are supposed to be usable by the end-user (developer) is it required to also add or update the corresponding Javadocs of the methods.
Deprecating a method requires you to add a `@deprecated` tag to the comments and mention the next version this may get removed.