From ab81fd9c277900c85da0c322a2ff9d68a235b2e6 Mon Sep 17 00:00:00 2001 From: Peter Bittner Date: Sun, 30 Aug 2020 00:19:09 +0200 Subject: Add GitHub templates from Werkzeug (#1282) --- .github/ISSUE_TEMPLATE.md | 33 ------------------------------- .github/ISSUE_TEMPLATE/bug-report.md | 27 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 15 ++++++++++++++ .github/pull_request_template.md | 26 ++++++++++++++++++++++++ 5 files changed, 79 insertions(+), 33 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/pull_request_template.md (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 4273496d..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,33 +0,0 @@ -The issue tracker is a tool to address bugs in Jinja itself. -Please use the #pocoo IRC channel on freenode or Stack Overflow for general -questions about using Jinja or issues not related to Jinja. - -If you'd like to report a bug in Jinja, fill out the template below and provide -any extra information that may be useful / related to your problem. -Ideally, you create an [MCVE](http://stackoverflow.com/help/mcve) reproducing -the problem before opening an issue to ensure it's not caused by something in -your code. - ---- - -## Expected Behavior -Tell us what should happen - -## Actual Behavior -Tell us what happens instead - -## Template Code -```jinja -Paste the template code (ideally a minimal example) that causes the issue - -``` - -## Full Traceback -```pytb -Paste the full traceback in case there is an exception - -``` - -## Your Environment -* Python version: -* Jinja version: diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..77e1c2b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: Report a bug in Jinja (not other projects which depend on Jinja) +--- + + + + + + + +Environment: + +- Python version: +- Jinja version: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..22e76808 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Security issue + url: security@palletsprojects.com + about: Do not report security issues publicly. Email our security contact. + - name: Questions + url: https://stackoverflow.com/questions/tagged/Jinja?tab=Frequent + about: Search for and ask questions about your code on Stack Overflow. + - name: Questions and discussions + url: https://discord.gg/t6rrQZH + about: Discuss questions about your code on our Discord chat. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..29053e22 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,15 @@ +--- +name: Feature request +about: Suggest a new feature for Jinja +--- + + + + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..23cd0881 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,26 @@ + + + + +- fixes # + + + +Checklist: + +- [ ] Add tests that demonstrate the correct behavior of the change. Tests should fail without the change. +- [ ] Add or update relevant docs, in the docs folder and in code. +- [ ] Add an entry in `CHANGES.rst` summarizing the change and linking to the issue. +- [ ] Add `.. versionchanged::` entries in any relevant code docs. +- [ ] Run `pre-commit` hooks and fix any issues. +- [ ] Run `pytest` and `tox`, no tests failed. -- cgit v1.2.3