update issue templates

davidism · davidism · commit 5e25c99fb10e · 2021-02-08T18:42:54.000-08:00
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Report a bug in Flask-SQLAlchemy (not SQLAlchemy, not other projects which depend on Flask-SQLAlchemy)
+---
+
+<!--
+This issue tracker is a tool to address bugs in Flask-SQLAlchemy itself.
+Please use Pallets Discord or Stack Overflow for questions about your
+own code.
+
+Ensure your issue is with Flask-SQLAlchemy and not SQLAlchemy itself.
+
+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:
+- Flask-SQLAlchemy version:
+- SQLAlchemy version:
diff --git a/.github/ISSUE_TEMPLATE/config.yml 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/flask-sqlalchemy?tab=Frequent
+    about: Search for and ask questions about your code on Stack Overflow.
+  - name: Questions and discussions
+    url: https://discord.gg/pallets
+    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
@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest a new feature for Flask-SQLAlchemy
+---
+
+<!--
+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 Werkzeug,
+such as by subclassing or using an extension?
+-->
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,30 @@
+<!--
+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.
