SpigotMC-Mirrors
/
PlaceholderAPI
mirror of https://github.com/PlaceholderAPI/PlaceholderAPI
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Do some changes

This commit is contained in:
Andre_601 2020-08-03 16:51:46 +02:00 committed by GitHub
parent e3d71843ac
commit 19a80c2d26
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
.github/CONTRIBUTING.md vendored
View File

@ -1,65 +1,51 @@
[issue]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new
[discord]: https://helpch.at/discord
[Code of Conduct]: https://github.com/PlaceholderAPI/PlaceholderAPI/blob/master/CODE_OF_CONDUCT.md
[code of conduct]: https://github.com/PlaceholderAPI/PlaceholderAPI/blob/master/CODE_OF_CONDUCT.md
[wiki]: https://github.com/PlaceholderAPI/PlaceholderAPI/blob/master/wiki
[style]: https://github.com/PlaceholderAPI/PlaceholderAPI/tree/master/config/style
# Contributing Guidelines
We welcome everyone to contribute towards the PlaceholderAPI Project, but doing so will require you to follow specific rules to keep a consistent and welcoming way of contributing.
If you have any questions about this contributing file, feel free to contact us on our [Discord Server][discord].
If you have any questions about contributions towards the project, feel free to contact us on our [Discord Server][discord].
## Issues
Like any other Project can you encounter bugs or a feature is missing for you in the plugin.
Like any other project can you encounter bugs or a feature is missing for you in the plugin.
For that can you open an [issue] to report a bug or suggest a new feature to be added.
When doing so, make sure you follow the below rules.
### Follow the Template
We have Issue templates to help us get the required information more easly. Please follow the provided template when either filing a bug report or feature request.
We reserve the right to close your issue without warning for not following the templates.
### Follow the template
We have issue templates to help us get the required information more easily. Please follow the provided template when either filing a bug report or feature request.
Your issue may be closed without warning for not following the template.
### Using Latest Version
When it comes to bug reports should you always check first, if you're using the latest release of PlaceholderAPI.
Often is a bug you encounter fixed in a newer release.
### Use the latest version
When it comes to bug reports should you always check first, that you're using the latest release of PlaceholderAPI.
Often the bug you've encountered, is fixed in a newer version.
You can optionally also try out development builds to see, if your bug is fixed in those.
The same rules apply for when making a feature request.
The same rules apply when making a feature request.
### No duplicate issue
Make sure that there isn't any existing issue, which is still open, or is closed with a solution/explanation.
Make sure that there aren't any existing issues relating to the problem, which are still open, or are closed with a solution/explanation.
Opening a separate issue for a bug report or feature request, that already exists on the issue tracker only slows down the process of fixing the bug or implementing the feature.
If an issue with the bug or feature you want to report/suggest exists, comment on it with your info (bug reports) or give it a :thumbsup: (Feature Request) to show that this is important for you.
### Issue isn't caused by external source
PlaceholderAPI provides a feature to have extensions (separate jar files) for placeholders. This gives it a possability that an issue you encounter is caused by said extensions or a separate plugin that uses those extensions.
In those cases should you report the issue to the issue tracker of the extension or plugin.
PlaceholderAPI provides a feature to have expansions (separate jar files) for placeholders. This gives it a possability that an issue you encounter is caused by said expansions or a separate plugin that uses those expansions.
In those cases should you report the issue to the issue tracker of the expansion or plugin.
## Pull requests
As an open source project are we welcoming all contributions to improve PlaceholderAPI, being it changes to its code like bug fixes or new features, or contributions to its documentation such as the Wiki or the Javadoc.
As an open source project are we welcoming all contributions to improve PlaceholderAPI, being it changes to its code like bug fixes or new features, or contributions to its documentation such as the [Wiki] or the Javadoc.
### Code contributions
Any contributions to PlaceholderAPI's code should be done towards the `develop` branch. Targeting the `master` branch in your Pull request may get it closed without warning.
Additionally should you follow the `Google Codestyle` when changing the code and Javadoc.
Some noteworthy points about Javadoc:
- `@param` tags are in a single line and any additional param tag after one don't have an empty line in between.
Example:
```java
/**
* @param param1 description
* @param param2 description
*/
```
- Tags follow the order `@param`, `@return`, `@since` and `@deprecated`
- The `@deprecated` tag should mention the version of when the annotated object will be removed. This usually would be the next minor version.
Additionally should you follow the project's codestyle which you can find in the [`config/style`][style] directory.
### Wiki/Javadoc contributions
If your Pull request only targets the [wiki] or only changes the Javadoc of PlaceholderAPI (And not its actual code) should Pull requests target the `docs` branch.
If your pull request only targets the [wiki] or only changes the javadoc comments of PlaceholderAPI (And not its actual code), it should be to `docs` branch.
The develop branch should only be targeted when you also change some of PlaceholderAPI's code.
## Code of Conduct
We have a [Code of Conduct] to maintain a welcoming atmosphere in this project.
If your contributions go against the above linked Code of Conduct will we reserve the right t deny or revert your contributions and to permanently remove your access from this project.
If your contributions go against the Code of Conduct, linked above, we reserve the right to deny or revert your contributions.