From d86826277d764217311d0d34a8e6143d09237a94 Mon Sep 17 00:00:00 2001 From: Aaron Raimist Date: Tue, 13 Nov 2018 21:43:23 -0600 Subject: Add a pull request template and add multiple issue templates Signed-off-by: Aaron Raimist --- .github/ISSUE_TEMPLATE.md | 48 ---------------------- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 66 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 9 +++++ .github/ISSUE_TEMPLATE/SUPPORT_REQUEST.md | 9 +++++ .github/PULL_REQUEST_TEMPLATE.md | 7 ++++ 5 files changed, 91 insertions(+), 48 deletions(-) delete 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/ISSUE_TEMPLATE/SUPPORT_REQUEST.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 21acb3202a..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,48 +0,0 @@ - - -### Description - -Describe here the problem that you are experiencing, or the feature you are requesting. - -### Steps to reproduce - -- For bugs, list the steps -- that reproduce the bug -- using hyphens as bullet points - -Describe how what happens differs from what you expected. - - - -### Version information - - - -- **Homeserver**: Was this issue identified on matrix.org or another homeserver? - -If not matrix.org: -- **Version**: What version of Synapse is running? -- **Install method**: package manager/git clone/pip -- **Platform**: Tell us about the environment in which your homeserver is operating - - distro, hardware, if it's running in a vm/container, etc. diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 0000000000..756759c2d8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,66 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + + marks will be invisible in the report. + +--> + +### Description + + + +### Steps to reproduce + +- list the steps +- that reproduce the bug +- using hyphens as bullet points + + + +### Version information + + + + +- **Homeserver**: + +If not matrix.org: + + +- **Version**: + +- **Install method**: + + +- **Platform**: + diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md new file mode 100644 index 0000000000..150a46f505 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -0,0 +1,9 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +**Description:** + + diff --git a/.github/ISSUE_TEMPLATE/SUPPORT_REQUEST.md b/.github/ISSUE_TEMPLATE/SUPPORT_REQUEST.md new file mode 100644 index 0000000000..96baa106dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/SUPPORT_REQUEST.md @@ -0,0 +1,9 @@ +--- +name: Support Request +about: I need support for Synapse + +--- + +# Please ask for support in [**#matrix:matrix.org**](https://matrix.to/#/#matrix:matrix.org) + +## Don't file an issue as a support request. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..aa883ba505 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,7 @@ +### Pull Request Checklist + + + +* [ ] Pull request is based on the develop branch +* [ ] Pull request includes a [changelog file](CONTRIBUTING.rst#changelog) +* [ ] Pull request includes a [sign off](CONTRIBUTING.rst#sign-off) -- cgit 1.5.1 From 9ca12155821f3aae4d9a4c589e370df31ea8f73d Mon Sep 17 00:00:00 2001 From: Aaron Raimist Date: Tue, 13 Nov 2018 21:46:43 -0600 Subject: Add changelog Signed-off-by: Aaron Raimist --- changelog.d/4182.misc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/4182.misc diff --git a/changelog.d/4182.misc b/changelog.d/4182.misc new file mode 100644 index 0000000000..62949a065a --- /dev/null +++ b/changelog.d/4182.misc @@ -0,0 +1 @@ +Add a GitHub pull request template and add multiple issue templates -- cgit 1.5.1 From 5d027048228f71648b27dd009891f2bc3e5f8d88 Mon Sep 17 00:00:00 2001 From: Aaron Raimist Date: Tue, 13 Nov 2018 21:57:10 -0600 Subject: Add SUPPORT.md https://help.github.com/articles/adding-support-resources-to-your-project/ --- .github/SUPPORT.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .github/SUPPORT.md diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000000..7a4244f673 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,3 @@ +[**#matrix:matrix.org**](https://matrix.to/#/#matrix:matrix.org) is the official support room for Matrix, and can be accessed by any client from https://matrix.org/docs/projects/try-matrix-now.html + +It can also be access via IRC bridge at irc://irc.freenode.net/matrix or on the web here: https://webchat.freenode.net/?channels=matrix -- cgit 1.5.1 From 924c82ca161e6ac389115791c8be2fd1bb60b3a5 Mon Sep 17 00:00:00 2001 From: Aaron Raimist Date: Tue, 13 Nov 2018 22:11:47 -0600 Subject: Fix case Signed-off-by: Aaron Raimist --- .github/ISSUE_TEMPLATE/SUPPORT_REQUEST.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/SUPPORT_REQUEST.md b/.github/ISSUE_TEMPLATE/SUPPORT_REQUEST.md index 96baa106dd..77581596c4 100644 --- a/.github/ISSUE_TEMPLATE/SUPPORT_REQUEST.md +++ b/.github/ISSUE_TEMPLATE/SUPPORT_REQUEST.md @@ -1,5 +1,5 @@ --- -name: Support Request +name: Support request about: I need support for Synapse --- -- cgit 1.5.1