mirror of
https://github.com/PlaceholderAPI/PlaceholderAPI.git
synced 2024-11-29 22:13:50 +01:00
commit
21048f83d5
64
.github/CONTRIBUTING.md
vendored
Normal file
64
.github/CONTRIBUTING.md
vendored
Normal file
@ -0,0 +1,64 @@
|
|||||||
|
[issue]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_placeholderapi.md
|
||||||
|
[Discord]: https://helpch.at/discord
|
||||||
|
[homepage]: http://contributor-covenant.org
|
||||||
|
[version]: http://contributor-covenant.org/version/1/4/
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
1. Update the README.md with details of changes if it is affected by those changes.
|
||||||
|
2. Try to prevent any breaking changes affecting the end-user (Developers using the API).
|
||||||
|
Mention any breaking changes that could affect the end-user.
|
||||||
|
3. Document any public methods that the end-user might use.
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
### Our Pledge
|
||||||
|
|
||||||
|
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||||
|
|
||||||
|
### Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to creating a positive environment
|
||||||
|
include:
|
||||||
|
|
||||||
|
* Using welcoming and inclusive language
|
||||||
|
* Being respectful of differing viewpoints and experiences
|
||||||
|
* Gracefully accepting constructive criticism
|
||||||
|
* Focusing on what is best for the community
|
||||||
|
* Showing empathy towards other community members
|
||||||
|
|
||||||
|
Examples of unacceptable behavior by participants include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||||
|
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||||
|
|
||||||
|
### Our Responsibilities
|
||||||
|
|
||||||
|
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
||||||
|
|
||||||
|
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
||||||
|
|
||||||
|
### Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
||||||
|
|
||||||
|
### Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at our [Discord]. All
|
||||||
|
complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
||||||
|
|
||||||
|
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
||||||
|
|
||||||
|
### Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||||
|
available at [http://contributor-covenant.org/version/1/4][version]
|
22
.github/ISSUE_TEMPLATE/bug_report.md
vendored
22
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,21 +1,23 @@
|
|||||||
---
|
---
|
||||||
name: Bug Report
|
name: Bug Report
|
||||||
about: Found a bug with PlaceholderAPI? Report it through this form!
|
about: Report bugs of PlaceholderAPI with this template
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
[New placeholders/plugin]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=feature_request.md
|
[Request change (Wiki)]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_wiki.md
|
||||||
[Request change]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request.md
|
[Request change (PlaceholderAPI)]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_placeholderapi.md
|
||||||
[Spigot page]: https://www.spigotmc.org/resources/6245/
|
[Spigot]: https://www.spigotmc.org/resources/6245/
|
||||||
[Jenkins page]: http://ci.extendedclip.com/job/PlaceholderAPI/
|
[Jenkins]: http://ci.extendedclip.com/job/PlaceholderAPI/
|
||||||
[issue]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues
|
[issue]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues
|
||||||
|
|
||||||
### Notes
|
## Please read
|
||||||
This template is for **reporting a bug** and not for requesting changes to the wiki!
|
This template is only for reporting bugs of PlaceholderAPI!
|
||||||
If you want your placeholders added or updated, use the [New placeholders/plugin] or [Request change] template.
|
If you want to request changes to the code of PlaceholderAPI, use the [Request change (PlaceholderAPI)] template.
|
||||||
|
For changes to the wiki use the [Request change (Wiki)] template.
|
||||||
|
|
||||||
Also make sure, that you use the latest version of PlaceholderAPI from either the [Spigot page] or the [Jenkins page] and that your
|
Please also make sure that you use the [latest release][Spigot] or the latest [developement build][Jenkins] and that your bug isn't already reported on the [issues] page.
|
||||||
issue isn't already listed in the [issue] page.
|
|
||||||
|
**Please report issues with expansions/placeholders to the corresponding issue tracker! Only report it here if you can't find any place to report it!**
|
||||||
|
|
||||||
### Issue
|
### Issue
|
||||||
> What is the issue? Describe it like you would tell a friend.
|
> What is the issue? Describe it like you would tell a friend.
|
||||||
|
36
.github/ISSUE_TEMPLATE/change_request.md
vendored
36
.github/ISSUE_TEMPLATE/change_request.md
vendored
@ -1,36 +0,0 @@
|
|||||||
---
|
|
||||||
name: Request change
|
|
||||||
about: Request a update/change of a wiki-page
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[New placeholders/plugin]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=feature_request.md
|
|
||||||
[Bug report]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=bug_report.md
|
|
||||||
[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues
|
|
||||||
[wiki]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki
|
|
||||||
|
|
||||||
### Notes
|
|
||||||
This template is for **requesting changes to the wiki** and not for reporting bugs or requesting additions for the wiki!
|
|
||||||
If you want your placeholders added, use the [New placeholders/plugin] template.
|
|
||||||
For bug reports, use the [Bug report] template.
|
|
||||||
|
|
||||||
Also make sure, that your requested change isn't already made in the [wiki] or listed in the [issues] page.
|
|
||||||
|
|
||||||
### Type
|
|
||||||
> What kind of change is it? (Multiple selections possible)
|
|
||||||
<!-- Please select the right one, by changing the [ ] to [x] -->
|
|
||||||
|
|
||||||
- [ ] Placeholder(s) changed.
|
|
||||||
- [ ] New placeholder(s).
|
|
||||||
- [ ] Plugin no longer supports PlaceholderAPI and/or was deleted.
|
|
||||||
|
|
||||||
### Plugin
|
|
||||||
> What is the name of the plugin?
|
|
||||||
<!-- Please type below this line -->
|
|
||||||
|
|
||||||
|
|
||||||
### What is the new value?
|
|
||||||
> **Placeholder(s) changed**: Type what the old and the new placeholder(s) is/are.
|
|
||||||
> **New Placeholder(s)**: Type the new placeholder(s).
|
|
||||||
> **Plugin no longer supports PlaceholderAPI**: Leave this blank.
|
|
||||||
<!-- Please type below this line -->
|
|
38
.github/ISSUE_TEMPLATE/change_request_placeholderapi.md
vendored
Normal file
38
.github/ISSUE_TEMPLATE/change_request_placeholderapi.md
vendored
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
---
|
||||||
|
name: Request change (PlaceholderAPI)
|
||||||
|
about: Request a update/change of the PlaceholderAPI-code
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[Request change (Wiki)]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_wiki.md
|
||||||
|
[Bug report]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=bug_report.md
|
||||||
|
[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues
|
||||||
|
[wiki]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki
|
||||||
|
[Pull Requests]: https://github.com/PlaceholderAPI/PlaceholderAPI/pulls
|
||||||
|
|
||||||
|
## Please read
|
||||||
|
This template is only for requesting new functions to be added to PlaceholderAPI or for old one to be changed!
|
||||||
|
Please use the [Request change (Wiki)] template to ask for additions/changes to the wiki.
|
||||||
|
For reporting bugs of PlaceholderAPI use the [Bug report] template.
|
||||||
|
|
||||||
|
Also make sure that the [wiki] doesn't already mention such a function/change and that there isn't a issue about this change on the [issues] page.
|
||||||
|
|
||||||
|
We recommend to [open a Pull Request][Pull Requests] for making changes to PlaceholderAPI's code.
|
||||||
|
|
||||||
|
### Type
|
||||||
|
> What kind of request is this? (Multiple selections possible)
|
||||||
|
<!--
|
||||||
|
Please select the right options by replacing the [ ] with a [x]
|
||||||
|
-->
|
||||||
|
- [ ] New function for PlaceholderAPI.
|
||||||
|
A new function that developers could use.
|
||||||
|
- [ ] Change to code (Internal).
|
||||||
|
Changes to code that won't affect the end-user.
|
||||||
|
- [ ] Change to code (External).
|
||||||
|
Changes to code that will affect the end-user (breaks stuff).
|
||||||
|
- [ ] Other: __________ <!-- Use this if none of the above matches your request -->
|
||||||
|
|
||||||
|
### Info
|
||||||
|
> What is the change?
|
||||||
|
> Please provide as much information (including links, images and code-snippeds) as possible.
|
||||||
|
<!-- Please type below this line -->
|
34
.github/ISSUE_TEMPLATE/change_request_wiki.md
vendored
Normal file
34
.github/ISSUE_TEMPLATE/change_request_wiki.md
vendored
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
name: Request change (Wiki)
|
||||||
|
about: Request a update/change of a wiki-page
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[Request change (PlaceholderAPI)]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_placeholderapi.md
|
||||||
|
[Bug report]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=bug_report.md
|
||||||
|
[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues
|
||||||
|
[wiki]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki
|
||||||
|
|
||||||
|
## Please read
|
||||||
|
This template is only for requesting new information to be added to the wiki or for updating of already existing information!
|
||||||
|
Please use the [Request change (PlaceholderAPI)] template to ask for additions/changes to the plugin PlaceholderAPI.
|
||||||
|
For reporting bugs of PlaceholderAPI use the [Bug report] template.
|
||||||
|
|
||||||
|
Also make sure that the [wiki] doesn't already have the change and that there isn't a issue about this change on the [issues] page.
|
||||||
|
|
||||||
|
### Type
|
||||||
|
> What kind of change is it? (Multiple selections possible)
|
||||||
|
<!--
|
||||||
|
Please select the right one, by changing the [ ] to [x]
|
||||||
|
-->
|
||||||
|
- [ ] New plugin/expansion supporting PlaceholderAPI.
|
||||||
|
A new plugin/expansion uses and/or provides placeholders.
|
||||||
|
- [ ] Placeholder(s) changed.
|
||||||
|
An already listed expansion/plugin has new placeholders or old ones have changed.
|
||||||
|
- [ ] Plugin/Expansion no longer supports PlaceholderAPI and/or was deleted.
|
||||||
|
- [ ] Other: __________ <!-- Use this if none of the above matches your request -->
|
||||||
|
|
||||||
|
### Info
|
||||||
|
> Please provide any information that is useful including links and images.
|
||||||
|
> For plugins/expansion providing new placeholders or updating old ones, provide the placeholders (that have changed)
|
||||||
|
<!-- Please type below this line -->
|
35
.github/ISSUE_TEMPLATE/feature_request.md
vendored
35
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,35 +0,0 @@
|
|||||||
---
|
|
||||||
name: New placeholders/plugin
|
|
||||||
about: Do you have a plugin that supports and/or adds placeholders from/to PlaceholderAPI and that isn't on the wiki? Use this template!
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
[Request change]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request.md
|
|
||||||
[Bug report]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=bug_report.md
|
|
||||||
[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues
|
|
||||||
[wiki]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki
|
|
||||||
|
|
||||||
### Notes
|
|
||||||
This template is for **requesting additions for the wiki** and not for reporting bugs or requesting changes for the wiki!
|
|
||||||
If you want changes to be made to the wiki, use the [Request change] template.
|
|
||||||
For bug reports, use the [Bug report] template.
|
|
||||||
|
|
||||||
Also make sure, that your requested placeholders/plugin isn't already added in the [wiki] or listed in the [issues] page.
|
|
||||||
|
|
||||||
### Type
|
|
||||||
> What kind of request is this? (Multiple selections possible)
|
|
||||||
<!-- Select the right option by replacing [ ] with [x] -->
|
|
||||||
<!-- For an update of an already listed plugin, use the "Request change" template -->
|
|
||||||
|
|
||||||
- [ ] New expansion providing placeholders.
|
|
||||||
- [ ] New plugin providing placeholders.
|
|
||||||
- [ ] New plugin supporting PlaceholderAPI.
|
|
||||||
|
|
||||||
### Plugin
|
|
||||||
> What is the name of the plugin/expansion?
|
|
||||||
> Provide also a link to it.
|
|
||||||
<!-- Please type below this line -->
|
|
||||||
|
|
||||||
### Placeholders/others
|
|
||||||
> What are the new placeholders/Any additional info?
|
|
||||||
<!-- Please type below this line -->
|
|
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
[Pull requests]: https://github.com/PlaceholderAPI/PlaceholderAPI/pulls
|
||||||
|
[contributing file]: https://github.com/PlaceholderAPI/PlaceholderAPI/tree/master/.github/CONTRIBUTING.md
|
||||||
|
|
||||||
|
## Please read
|
||||||
|
Please make sure you checked the following:
|
||||||
|
- You checked the [Pull requests] page for any upcoming changes.
|
||||||
|
- You documented any public code that the end-user might use.
|
||||||
|
- You followed the [contributing file]
|
||||||
|
|
||||||
|
### Type
|
||||||
|
<!--
|
||||||
|
Please select the right one, by changing the [ ] to [x]
|
||||||
|
-->
|
||||||
|
- [ ] Internal change (Doesn't affect end-user).
|
||||||
|
- [ ] External change (Does affect end-user).
|
||||||
|
- [ ] Other: __________ <!-- Use this if none of the above matches your request -->
|
||||||
|
|
||||||
|
### Description
|
||||||
|
> Provide additional information if needed.
|
||||||
|
<!-- Please type below this line -->
|
Loading…
Reference in New Issue
Block a user