Add a Pull Request template to guide contributions (#1407)

* Add a Pull Request template to guide contributions * Apply suggestions from code review Co-authored-by: Heitor Tashiro Sergent <[email protected]> * Apply suggestions from code review --------- Co-authored-by: Heitor Tashiro Sergent <[email protected]>
grafana · Nov 28, 2023 · 5a30f54 · 5a30f54
1 parent 1a405f3
commit 5a30f54
Showing 1 changed file with 35 additions and 0 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,35 @@
+<!-- 
+Please make sure you have read the contribution guidelines https://github.com/grafana/k6/blob/master/CONTRIBUTING.md as well as the
+the code of conduct https://github.com/grafana/k6/blob/master/CODE_OF_CONDUCT.md before opening a PR.
+-->
+
+## What?
+
+<!-- A description of the changes this PR brings to the documentation. -->
+
+## Checklist
+
+Please fill in this template:
+- [ ] I have used a meaningful title for the PR.
+- [ ] I have described the changes I've made in the "What?" section above.
+- [ ] I have performed a self-review of my changes.
+- [ ] I have run the `make docs` command locally and verified that the changes look good.
+
+Select one of these and delete the others:
+
+If updating the documentation for the most recent release of k6: 
+- [ ] I have made my changes in the `docs/sources/v{most_recent_release}` folder of the documentation.
+- [ ] I have reflected my changes in the `docs/sources/next` folder of the documentation.
+- [ ] I have reflected my changes in the relevant (*e.g.*  when correcting a documentation error) folders of the previous k6 versions of the documentation.
+
+If updating the documentation for the next release of k6:
+- [ ] I have made my changes in the `docs/sources/next` folder of the documentation.
+
+## Related PR(s)/Issue(s)
+
+<!-- - <https://github.com/grafana/...> -->
+
+<!-- Does it close an issue? -->
+<!-- Closes #ISSUE-ID -->
+
+<!-- Thanks for your contribution! 🙏🏼 -->