aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/custom.md32
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md15
2 files changed, 47 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md
new file mode 100644
index 0000000..ac97269
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/custom.md
@@ -0,0 +1,32 @@
+---
+name: Custom issue template
+about: General issues, both bugs and features.
+title: ''
+labels: ''
+assignees: mssola
+---
+
+### Description
+
+Check out the [contribution guidelines](../CONTRIBUTING.org) file for some considerations before submitting a new issue.
+
+### Steps to reproduce
+
+1. First I did this...
+2. Then that...
+3. And this happened!
+
+- **Expected behavior**: I expected this to happen!
+- **Actual behavior**: But this happened...
+
+### g version
+
+With a git commit SHA if possible.
+
+### Shell version
+
+Provide the shell version if possible.
+
+### Operating system
+
+The operating system and the exact version you are using.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..73e55f7
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,15 @@
+Provide a general description of the changes in your pull request. If this pull
+request fixes a known issue, please tag it as well (e.g.: `Fixes #1`).
+
+Before submitting a PR make sure the following things have been done (and denote
+this by checking the relevant checkboxes):
+
+- [ ] The commits are consistent with the [contribution guidelines](../CONTRIBUTING.org).
+- [ ] You've added tests (if possible) to cover your change(s).
+- [ ] Tests are passing (`make test`).
+- [ ] You've updated the [changelog](../CHANGELOG.org) (if adding/changing
+ user-visible functionality).
+- [ ] You've updated the [readme](../README.org) (if adding/changing
+ user-visible functionality).
+
+Thanks for contributing to this project!