From 40dfb3f3eb07f0ae3b9ef969ae000ea34e01468b Mon Sep 17 00:00:00 2001 From: Alexander Trost Date: Sun, 3 Jun 2018 12:58:18 +0200 Subject: [PATCH] github: Added issue and pull request templates This adds issue and pull request templates so the user will be asked for general information, such as Ceph version, OS, kernel, to help make it faster to debug issues and/or see if something is missing in a PR (e.g. documentation updates). The pull request template gives the user a checklist for certain points that need to be kept in mind. Signed-off-by: Alexander Trost --- .github/ISSUE_TEMPLATE.md | 33 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 25 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 26 ++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 12 +++++++++ 4 files changed, 96 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.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 000000000..e4ef633e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,33 @@ + + +Is this a bug report or feature request? + +* Bug Report +* Feature Request + +**Bug Report** + +What happened: + +What you expected to happen: + +How to reproduce it (minimal and precise): + + +**Feature Request** + +Are there any similar features already existing: + +What should the feature do: + +What would be solved through this feature: + +Does this have an impact on existing features: + +**Environment**: +* OS (e.g. from /etc/os-release): +* Kernel (e.g. `uname -a`): +* Docker version (e.g. `docker version`): +* Ceph version (e.g. `ceph -v`): diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..00a2e0071 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,25 @@ +--- +name: Bug report +about: Create a report to help us improve +--- + + +Is this a bug report or feature request? +* Bug Report + +**Bug Report** + +What happened: + +What you expected to happen: + +How to reproduce it (minimal and precise): + + +**Environment**: +* OS (e.g. from /etc/os-release): +* Kernel (e.g. `uname -a`): +* Docker version (e.g. `docker version`): +* Ceph version (e.g. `ceph -v`): diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..58c7e4d30 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: Feature request +about: Suggest an idea/feature for this project +--- + + +Is this a bug report or feature request? +* Feature Request + +**Feature Request** + +Are there any similar features already existing: + +What should the feature do: + +What would be solved through this feature: + +Does this have an impact on existing features: + +**Environment**: +* OS (e.g. from /etc/os-release): +* Kernel (e.g. `uname -a`): +* Docker version (e.g. `docker version`): +* Ceph version (e.g. `ceph -v`): diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..ea18fe5a9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ + + +Description of your changes: + +Which issue is resolved by this Pull Request: +Resolves # + +Checklist: +- [ ] Documentation has been updated, if necessary. +- [ ] Pending release notes updated with breaking and/or notable changes, if necessary.