From 2ee8627c5ad3346ac3c93d5723789edf48c7dfc5 Mon Sep 17 00:00:00 2001 From: Bruno Alla Date: Tue, 17 Jan 2017 22:34:04 +0000 Subject: [PATCH] Pull request and issue template fixes #254 --- .github/ISSUE_TEMPLATE.md | 14 ++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..f384dde --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,14 @@ +## Problem + +Explain the problem you encountered. + +## Environment + +- Django Model Utils version: +- Django version: +- Python version: +- Other libraries used, if any: + +## Code examples + +Give code example that demonstrates the issue, or even better, write new tests that fails because of that issue. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..63db703 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +## Problem + +Explain the problem you are fixing (add the link to the related issue(s), if any). + +## Solution + +Explain the solution that has been implemented, and what has been changed. + +## Commandments + +- [ ] Write PEP8 compliant code. +- [ ] Cover it with tests. +- [ ] Update `CHANGES.rst` file to describe the changes, and quote according issue with `GH-`. +- [ ] Pay attention to backward compatibility, or if it breaks it, explain why. +- [ ] Update documentation (if relevant).