summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorPeter Bittner <django@bittner.it>2020-08-30 00:19:09 +0200
committerGitHub <noreply@github.com>2020-08-29 15:19:09 -0700
commitab81fd9c277900c85da0c322a2ff9d68a235b2e6 (patch)
treea8f5aaa93d8c120e57ffe54b46eb1724f6c900c2 /.github
parent61edc8e9cea761f861f1eabd7f5a60de570c5627 (diff)
downloadjinja2-ab81fd9c277900c85da0c322a2ff9d68a235b2e6.tar.gz
Add GitHub templates from Werkzeug (#1282)
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE.md33
-rw-r--r--.github/ISSUE_TEMPLATE/bug-report.md27
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml11
-rw-r--r--.github/ISSUE_TEMPLATE/feature-request.md15
-rw-r--r--.github/pull_request_template.md26
5 files changed, 79 insertions, 33 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index 4273496..0000000
--- 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 0000000..77e1c2b
--- /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)
+---
+
+<!--
+This issue tracker is a tool to address bugs in Jinja itself. Please
+use Pallets Discord or Stack Overflow for questions about your own code.
+
+Replace this comment with a clear outline of what the bug is.
+-->
+
+<!--
+Describe how to replicate the bug.
+
+Include a minimal reproducible example that demonstrates the bug.
+Include the full traceback if there was an exception.
+-->
+
+<!--
+Describe the expected behavior that should have happened but didn't.
+-->
+
+Environment:
+
+- Python version:
+- Jinja version:
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..22e7680
--- /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 0000000..29053e2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest a new feature for Jinja
+---
+
+<!--
+Replace this comment with a description of what the feature should do.
+Include details such as links relevant specs or previous discussions.
+-->
+
+<!--
+Replace this comment with an example of the problem which this feature
+would resolve. Is this problem solvable without changes to Jinja,
+such as by subclassing or using an extension?
+-->
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..23cd088
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,26 @@
+<!--
+Before opening a PR, open a ticket describing the issue or feature the PR will address. Follow the steps in CONTRIBUTING.rst.
+
+Replace this comment with a description of the change. Describe how it addresses the linked ticket.
+-->
+
+<!--
+Link to relevant issues or previous PRs, one per line. Use "fixes" to automatically close an issue.
+-->
+
+- fixes #<issue number>
+
+<!--
+Ensure each step in CONTRIBUTING.rst is complete by adding an "x" to each box below.
+
+If only docs were changed, these aren't relevant and can be removed.
+-->
+
+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.