diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dff03f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug Report +about: Found a bug with PlaceholderAPI? Report it through this form! + +--- + +[New placeholders/plugin]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=feature_request.md +[Request change]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request.md +[Spigot page]: https://www.spigotmc.org/resources/6245/ +[Jenkins page]: http://ci.extendedclip.com/job/PlaceholderAPI/ +[issue]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues + +### Notes +This template is for **reporting a bug** and not for requesting changes to the wiki! +If you want your placeholders added or updated, use the [New placeholders/plugin] or [Request change] template. + +Also make sure, that you use the latest version of PlaceholderAPI from either the [Spigot page] or the [Jenkins page] and that your +issue isn't already listed in the [issue] page. + +### Issue +> What is the issue? Describe it like you would tell a friend. + + + +### Expected behaviour +> What should PlaceholderAPI do? + + + +### Actual behaviour +> What does PlaceholderAPI actually do? + + + +### How to reproduce +> What steps did you made, to get this bug? + +1. diff --git a/.github/ISSUE_TEMPLATE/change_request.md b/.github/ISSUE_TEMPLATE/change_request.md new file mode 100644 index 0000000..0c9bc75 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/change_request.md @@ -0,0 +1,36 @@ +--- +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) + + +- [ ] Placeholder(s) changed. +- [ ] New placeholder(s). +- [ ] Plugin no longer supports PlaceholderAPI and/or was deleted. + +### Plugin +> What is the name of the plugin? + + + +### 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. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..3e2b9b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,35 @@ +--- +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 being 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) + + + +- [ ] 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. + + +### Placeholders/others +> What are the new placeholders/Any additional info? + diff --git a/README.md b/README.md index 5eaf616..85660a4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,26 @@ -[![PlaceholderAPI Logo](https://i.imgur.com/Ea4PURv.png)][spigot] +[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues +[licenseImg]: https://img.shields.io/github/license/PlaceholderAPI/PlaceholderAPI.svg +[license]: https://github.com/PlaceholderAPI/PlaceholderAPI/blob/master/LICENSE -[![Build Status](http://ci.extendedclip.com/buildStatus/icon?job=PlaceholderAPI)][ci] +[releaseImg]: https://img.shields.io/github/release/PlaceholderAPI/PlaceholderAPI.svg?label=github%20release +[release]: https://github.com/PlaceholderAPI/PlaceholderAPI/releases/latest + +[discord]: https://helpch.at/discord +[spigot]: https://www.spigotmc.org/resources/6245/ +[Expansions cloud]: https://api.extendedclip.com/home +[placeholder list]: https://helpch.at/placeholders +[statistics]: https://bstats.org/plugin/bukkit/PlaceholderAPI + +[ci]: http://ci.extendedclip.com/job/PlaceholderAPI/ +[ciImg]: http://ci.extendedclip.com/buildStatus/icon?job=PlaceholderAPI + +[APIversionImg]: https://img.shields.io/nexus/r/http/repo.extendedclip.com/me.clip/placeholderapi.svg?label=API-Version +[logo]: https://i.imgur.com/Ea4PURv.png + + +[![logo]][spigot] + +[![ciImg]][ci] [![releaseImg]][release] ![APIversionImg] [![licenseImg]][license] # Information [PlaceholderAPI][spigot] is a plugin for Spigot servers that allows server owners to display information from various plugins with a uniform format. @@ -18,20 +38,7 @@ PlaceholderAPI has been downloaded over 100,000 times and has been used concurre ## Quick Links - [CI Server][ci] -- [Expansions Website][expansions] -- [Placeholder List][placeholder-list] +- [Expansions cloud] +- [Placeholder List] - [Spigot Page][spigot] - [Plugin Statistics][statistics] - -## License -PlaceholderAPI is licensed under the __GNU GPLv3__ license. Refer to the [LICENSE](LICENSE) file for more information. - - - -[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues -[discord]: https://discord.gg/7sndK3q -[spigot]: https://www.spigotmc.org/resources/placeholderapi.6245/ -[ci]: http://ci.extendedclip.com/job/PlaceholderAPI/ -[expansions]: https://api.extendedclip.com/all/ -[placeholder-list]: https://www.spigotmc.org/wiki/placeholderapi-placeholders/ -[statistics]: https://bstats.org/plugin/bukkit/PlaceholderAPI