From 949cd5acb7bbf2773496f19285efbc4c94271a3f Mon Sep 17 00:00:00 2001 From: Bruno Alla Date: Wed, 9 Sep 2020 14:07:30 +0200 Subject: [PATCH] Update issue and pull request templates --- .github/ISSUE_TEMPLATE.md | 1 - .github/ISSUE_TEMPLATE/bug.md | 32 ++++++++++++++++++-------- .github/ISSUE_TEMPLATE/feature.md | 18 ++++----------- .github/ISSUE_TEMPLATE/improvement.md | 24 ------------------- .github/ISSUE_TEMPLATE/paid-support.md | 8 ++++++- .github/ISSUE_TEMPLATE/question.md | 10 ++++++-- .github/ISSUE_TEMPLATE/regression.md | 28 ---------------------- .github/PULL_REQUEST_TEMPLATE.md | 25 ++++++++------------ cookiecutter.json | 1 - 9 files changed, 51 insertions(+), 96 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md delete mode 100644 .github/ISSUE_TEMPLATE/improvement.md delete mode 100644 .github/ISSUE_TEMPLATE/regression.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index b232b6e3..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1 +0,0 @@ -## [Make sure to follow one of the issue templates we've got](https://github.com/pydanny/cookiecutter-django/issues/new/choose), otherwise the issue might be closed immeditely diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 2a48c0c3..b2b577f5 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -1,21 +1,33 @@ --- name: Bug Report about: Report a bug +title: '[bug]' +labels: bug --- ## What happened? - - - ## What should've happened instead? +## Additional details + - -## Steps to reproduce - -[//]: # (Any or all of the following:) -[//]: # (* Host system configuration: OS, Docker & friends' versions etc.) -[//]: # (* Replay file https://cookiecutter.readthedocs.io/en/latest/advanced/replay.html) -[//]: # (* Logs) +* Host system configuration: + * Version of cookiecutter CLI (get it with `cookiecutter --version`): + * OS: + * Python version: + * Docker versions (if using Docker): + * ... +* Options selected and/or [replay file](https://cookiecutter.readthedocs.io/en/latest/advanced/replay.html): + ``` + ``` + +Logs: +
+
+$ cookiecutter https://github.com/pydanny/cookiecutter-django
+project_name [Project Name]: ...
+
+
+ diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md index b0d560d8..8cc8141a 100644 --- a/.github/ISSUE_TEMPLATE/feature.md +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -1,24 +1,14 @@ --- name: New Feature Proposal about: Propose a new feature +title: '[feature request]' +labels: enhancement --- ## Description -[//]: # (What's it you're proposing? How should it be implemented?) - - - +What are you proposing? How should it be implemented? ## Rationale -[//]: # (Why should this feature be implemented?) - - - - -## Use case(s) / visualization(s) - -[//]: # ("Better to see something once than to hear about it a thousand times.") - - +Why should this feature be implemented? diff --git a/.github/ISSUE_TEMPLATE/improvement.md b/.github/ISSUE_TEMPLATE/improvement.md deleted file mode 100644 index 57265237..00000000 --- a/.github/ISSUE_TEMPLATE/improvement.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Improvement Suggestion -about: Let us know how we could improve ---- - -## Description - -[//]: # (What's it you're proposing? How should it be implemented?) - - - - -## Rationale - -[//]: # (Why should this feature be implemented?) - - - - -## Use case(s) / visualization(s) - -[//]: # ("Better to see something once than to hear about it a thousand times.") - - diff --git a/.github/ISSUE_TEMPLATE/paid-support.md b/.github/ISSUE_TEMPLATE/paid-support.md index d565e564..e553329f 100644 --- a/.github/ISSUE_TEMPLATE/paid-support.md +++ b/.github/ISSUE_TEMPLATE/paid-support.md @@ -1,10 +1,16 @@ --- name: Paid Support Request about: Ask Core Team members to help you out +title: '' +labels: '' +assignees: '' + --- -Provided your question goes beyound [regular support](https://github.com/pydanny/cookiecutter-django/issues/new?template=question.md), and/or the task at hand is of timely/high priority nature use the below information to reach out for contributors directly. +Provided your question goes beyond [regular support](https://github.com/pydanny/cookiecutter-django/issues/new?template=question.md), and/or the task at hand is of timely/high priority nature use the below information to reach out for contributors directly. * Daniel Roy Greenfeld, Project Lead ([GitHub](https://github.com/pydanny), [Patreon](https://www.patreon.com/danielroygreenfeld)): expertise in Django and AWS ELB. * Nikita Shupeyko, Core Developer ([GitHub](https://github.com/webyneter)): expertise in Python/Django, hands-on DevOps and frontend experience. + +* Bruno Alla, Core Developer ([GitHub](https://github.com/sponsors/browniebroke)). diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 0c0f3d89..f24e413f 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,6 +1,12 @@ --- name: Question -about: Please, ask your question on StackOverflow or Gitter +about: Please consider asking your question on StackOverflow or Slack +title: '[question]' +labels: question --- -First, make sure to examine [the docs](https://cookiecutter-django.readthedocs.io/en/latest/). If that doesn't help post a question on [StackOverflow](https://stackoverflow.com/questions/tagged/cookiecutter-django) tagged with `cookiecutter-django`. Finally, feel free to join [Gitter](https://gitter.im/pydanny/cookiecutter-django) and ask around. +First, make sure to examine [the docs](https://cookiecutter-django.readthedocs.io/en/latest/). + +If that doesn't help, post a question on [StackOverflow](https://stackoverflow.com/questions/tagged/cookiecutter-django) tagged with `cookiecutter-django`, you might get more visibility there than on our issue tracker. + +Finally, feel free to join [Slack](https://join.slack.com/t/cookie-cutter/shared_invite/enQtNzI0Mzg5NjE5Nzk5LTRlYWI2YTZhYmQ4YmU1Y2Q2NmE1ZjkwOGM0NDQyNTIwY2M4ZTgyNDVkNjMxMDdhZGI5ZGE5YmJjM2M3ODJlY2U) and ask around. diff --git a/.github/ISSUE_TEMPLATE/regression.md b/.github/ISSUE_TEMPLATE/regression.md deleted file mode 100644 index 80384004..00000000 --- a/.github/ISSUE_TEMPLATE/regression.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: Regression Report -about: Let us know if something that'd been working has broke ---- - -## What happened before? - - - - -## What happens now? - - - - -## Last stable commit / Since when? - - - - -## Steps to reproduce - -[//]: # (Any or all of the following:) -[//]: # (* Host system configuration: OS, Docker & friends' versions etc.) -[//]: # (* Project generation options) -[//]: # (* Logs) - - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 45e67c69..5559e62f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,23 +1,18 @@ -[//]: # (Thank you for helping us out: your efforts mean great deal to the project and the community as a whole!) - -[//]: # (Before you proceed:) - -[//]: # (- Don't forget to update the `docs/` presuming others would benefit from a concise description of whatever that you're proposing) -[//]: # (- If you're adding a new option, please make sure that tests/test_cookiecutter_generation.py is updated accordingly) + ## Description -[//]: # (What's it you're proposing?) + +Checklist: + +- [ ] I've made sure that `tests/test_cookiecutter_generation.py` is updated accordingly (especially if adding or updating a template option) +- [ ] I've updated the documentation or confirm that my change doesn't require any updates ## Rationale -[//]: # (Why does the project need that?) - - -## Use case(s) / visualization(s) - -[//]: # ("Better to see something once than to hear about it a thousand times.") - - + diff --git a/cookiecutter.json b/cookiecutter.json index ca11b3b4..68206147 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -59,6 +59,5 @@ "Gitlab" ], "keep_local_envs_in_vcs": "y", - "debug": "n" }