From 85328c473b3ba8c741d760701dd9f4535a9197e3 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Sun, 2 Jun 2019 19:01:11 +0200 Subject: [PATCH 1/8] Improve the feature_request --- .github/ISSUE_TEMPLATE/feature_request.md | 32 +++++++++++------------ 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 890bdc0..7524ce7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,28 +8,28 @@ about: Do you have a plugin that supports and/or adds placeholders from/to Place [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 +[FAQ]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/FAQ -### 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. +### Please read +Please use this template for Feature requests only! +This doesn't include changes to already existing things like wiki-entries or code. Use the [Request change] template for those types of issues. +For bug reports regarding PlaceholderAPI 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. +Also make sure that you have read the [wiki], the [FAQ] and that you checked the [issues] page for any similar topic. ### Type > What kind of request is this? (Multiple selections possible) - - + -- [ ] New expansion providing placeholders. -- [ ] New plugin providing placeholders. +- [ ] New plugin or expansion that provides placeholders. - [ ] New plugin supporting PlaceholderAPI. +- [ ] New PlaceholderAPI feature. +- [ ] Other: __________ -### 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? +### New information +> What should be added? +> Please provide as much information like why it should be added. +> Also make sure to add links to it if possible. From 82181ed74d84a06382124f90a7e551489dc47dd3 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Sun, 2 Jun 2019 19:20:27 +0200 Subject: [PATCH 2/8] Update and rename change_request.md to change_request_wiki.md --- .github/ISSUE_TEMPLATE/change_request.md | 36 ------------------- .github/ISSUE_TEMPLATE/change_request_wiki.md | 34 ++++++++++++++++++ 2 files changed, 34 insertions(+), 36 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/change_request.md create mode 100644 .github/ISSUE_TEMPLATE/change_request_wiki.md diff --git a/.github/ISSUE_TEMPLATE/change_request.md b/.github/ISSUE_TEMPLATE/change_request.md deleted file mode 100644 index 0c9bc75..0000000 --- a/.github/ISSUE_TEMPLATE/change_request.md +++ /dev/null @@ -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) - - -- [ ] 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/change_request_wiki.md b/.github/ISSUE_TEMPLATE/change_request_wiki.md new file mode 100644 index 0000000..3bd1568 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/change_request_wiki.md @@ -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) + +- [ ] 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: __________ + +### 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) + From 0809897303ee23307ab229152f3a37cd9f4d0833 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Sun, 2 Jun 2019 19:30:12 +0200 Subject: [PATCH 3/8] Update and rename feature_request.md to change_request_placeholderapi.md --- .../change_request_placeholderapi.md | 38 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 35 ----------------- 2 files changed, 38 insertions(+), 35 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/change_request_placeholderapi.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/change_request_placeholderapi.md b/.github/ISSUE_TEMPLATE/change_request_placeholderapi.md new file mode 100644 index 0000000..4f21be7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/change_request_placeholderapi.md @@ -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) + +- [ ] 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: __________ + +### Info +> What is the change? +> Please provide as much information (including links, images and code-snippeds) as possible. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 7524ce7..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -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 -[FAQ]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/FAQ - -### Please read -Please use this template for Feature requests only! -This doesn't include changes to already existing things like wiki-entries or code. Use the [Request change] template for those types of issues. -For bug reports regarding PlaceholderAPI use the [Bug report] template. - -Also make sure that you have read the [wiki], the [FAQ] and that you checked the [issues] page for any similar topic. - -### Type -> What kind of request is this? (Multiple selections possible) - - -- [ ] New plugin or expansion that provides placeholders. -- [ ] New plugin supporting PlaceholderAPI. -- [ ] New PlaceholderAPI feature. -- [ ] Other: __________ - -### New information -> What should be added? -> Please provide as much information like why it should be added. -> Also make sure to add links to it if possible. - From c4cba9c6a75f09b44da92b82aecd885684393e1e Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Sun, 2 Jun 2019 19:37:57 +0200 Subject: [PATCH 4/8] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dff03f8..35cfabd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,21 +1,23 @@ --- 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]: 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/ +[Request change (Wiki)]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_wiki.md +[Request change (PlaceholderAPI)]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_placeholderapi.md +[Spigot]: https://www.spigotmc.org/resources/6245/ +[Jenkins]: 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. +## Please read +This template is only for reporting bugs of PlaceholderAPI! +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 -issue isn't already listed in the [issue] page. +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. + +**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 > What is the issue? Describe it like you would tell a friend. From 8c509b47d1b9926c53f6d4e851b63aadc32d8b32 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Sun, 2 Jun 2019 19:54:17 +0200 Subject: [PATCH 5/8] Create PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..3eacdf8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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 + +- [ ] Internal change (Doesn't affect end-user). +- [ ] External change (Does affect end-user). +- [ ] Other: __________ + +### Description +> Provide additional information if needed. + From b44cb13d7a68076fce613539d02e876e2bd23691 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Sun, 2 Jun 2019 19:56:33 +0200 Subject: [PATCH 6/8] Create CONTRIBUTING.md --- .github/CONTRIBUTING.md | 91 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..181804f --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,91 @@ +# 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. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md with details of changes to the interface, this includes new environment + variables, exposed ports, useful file locations and container parameters. +3. Increase the version numbers in any examples files and the README.md to the new version that this + Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). +4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. + +## 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 [INSERT EMAIL ADDRESS]. 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] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ From 16c237ce51308da5db74a95b3c9576486b203b04 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Sun, 2 Jun 2019 20:06:56 +0200 Subject: [PATCH 7/8] Update CONTRIBUTING.md --- .github/CONTRIBUTING.md | 64 ++++++++++++----------------------------- 1 file changed, 18 insertions(+), 46 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 181804f..6abb26c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,3 +1,8 @@ +[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. @@ -6,25 +11,15 @@ Please note we have a code of conduct, please follow it in all your interactions ## Pull Request Process -1. Ensure any install or build dependencies are removed before the end of the layer when doing a - build. -2. Update the README.md with details of changes to the interface, this includes new environment - variables, exposed ports, useful file locations and container parameters. -3. Increase the version numbers in any examples files and the README.md to the new version that this - Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). -4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you - do not have permission to do that, you may request the second reviewer to merge it for you. +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. ## 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. +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 @@ -39,53 +34,30 @@ include: Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or -advances +* 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 +* 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 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. +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. +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 [INSERT EMAIL ADDRESS]. 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. +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. +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] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ From 9af9a3570d3816bc1e052c07fce41edde4c1cc88 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Sun, 2 Jun 2019 20:07:40 +0200 Subject: [PATCH 8/8] Update CONTRIBUTING.md --- .github/CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 6abb26c..968f6ca 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -14,6 +14,7 @@ Please note we have a code of conduct, please follow it in all your interactions 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