From ccb4a633fe9000f8f9822a0e209831f4bca7d303 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=90=D0=BB=D0=B5=D0=BA=D1=81=D0=B0=D0=BD=D0=B4=D0=B0?= =?UTF-8?q?=D1=80=20=D0=A1=D0=B8=D0=BC=D0=B8=D1=9B?= Date: Mon, 7 Sep 2020 16:10:14 +0100 Subject: [PATCH] Added PR & issue templates To help with the maintenance of the project --- .github/issue_template.md | 19 +++++++++++++++++++ .github/pull_request_template.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 48 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..4345781 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,19 @@ +## Expected Behavior + + +## Actual Behavior + + +## Steps to Reproduce the Problem + +1. +1. +1. + +## Specifications + +- Version: +- Platform: +- Subsystem: + +## Anything else that you think is relevant diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..8bd2c34 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,29 @@ +## Description of your pull request + +**Replace this placeholder text with a summary of the changes in your PR. +The more detailed you are, the better.** + +## Why should it be considered? + +Please explain why you think that this change should be considered. + +Why am I asking this? + +If it's a new feature, I will be left to maintain it after it gets +merged in to the project. So I'm keen to know why I'll be taking on +the future maintenance of it. + +## Pull request checklist + +Before submitting the PR make sure the following things have been done +(and denote this by checking the relevant checkboxes): + +- [ ] The code is consistent with [Clojure style guide](https://github.com/bbatsov/clojure-style-guide#the-clojure-style-guide). +- [ ] All code passes the linter (`clj-kondo --lint src`). +- [ ] You've added tests (if possible) to cover your change(s). +- [ ] All tests are passing. +- [ ] The commits are consistent with [the Git commit style guide](https://chris.beams.io/posts/git-commit/). +- [ ] You've updated the [changelog](../blob/master/CHANGELOG.md) (if adding/changing user-visible functionality). + + +Thanks!