summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNejc Habjan <nejc.habjan@siemens.com>2023-02-12 14:43:31 +0100
committerJohn Villalovos <john@sodarock.com>2023-03-11 15:35:10 -0800
commitbf46c67db150f0657b791d94e6699321c9985f57 (patch)
treecc5269fb8753a081cf03432f6498723cbcde743b
parent07d03dc959128e05d21e8dfd79aa8e916ab5b150 (diff)
downloadgitlab-bf46c67db150f0657b791d94e6699321c9985f57.tar.gz
chore(github): add default pull request template
-rw-r--r--.github/PULL_REQUEST_TEMPLATE/pull_request_template.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
new file mode 100644
index 0000000..465fcb3
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,23 @@
+<!-- Please make sure your commit messages follow Conventional Commits
+(https://www.conventionalcommits.org) with a commit type (e.g. feat, fix, refactor, chore):
+
+Bad: Added support for release links
+Good: feat(api): add support for release links
+
+Bad: Update documentation for projects
+Good: docs(projects): update example for saving project attributes-->
+
+## Changes
+
+<!-- Remove this comment and describe your changes here. -->
+
+### Documentation and testing
+
+Please consider whether this PR needs documentation and tests. **This is not required**, but highly appreciated:
+
+- [ ] Documentation in the matching [docs section](https://github.com/python-gitlab/python-gitlab/tree/main/docs)
+- [ ] [Unit tests](https://github.com/python-gitlab/python-gitlab/tree/main/tests/unit) and/or [functional tests](https://github.com/python-gitlab/python-gitlab/tree/main/tests/functional)
+
+<!--
+Note: In some cases, basic functional tests may be easier to add, as they do not require adding mocked GitLab responses.
+-->