diff --git a/.github/PULL_REQUEST_TEMPLATE/plugin_template.md b/.github/PULL_REQUEST_TEMPLATE/plugin_template.md new file mode 100644 index 0000000000..f03fa6dcf0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/plugin_template.md @@ -0,0 +1,14 @@ + + + +👋 Hello and thank you for your contribution! + +**The PR fulfills these requirements:** + +- [ ] 🚀 Works with the latest major version of Cypress +- [ ] 🛠 Plugin purpose is clearly documented (in a README or docs website) +- [ ] 📝 Well-written documentation - A great example ([link](https://github.com/Fredx87/cypress-keycloak-commands#cypress-keycloak-commands)) +- [ ] 🔬 Tested using Cypress - tests using Cypress can act as both example usage _and_ test coverage +- [ ] 👷‍♀️ CI pipeline that's passing (CircleCI and [Github Actions](https://github.com/cypress-io/cypress-tutorial-build-todo/blob/master/.github/workflows) are both free for Open Source) + +If you have reason to believe your plugin does not need to meet certain requirements, please document it below.