Skip to content

Commit 5e25c99

Browse files
committed
update issue templates
1 parent f8910b8 commit 5e25c99

File tree

5 files changed

+87
-31
lines changed

5 files changed

+87
-31
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Report a bug in Flask-SQLAlchemy (not SQLAlchemy, not other projects which depend on Flask-SQLAlchemy)
4+
---
5+
6+
<!--
7+
This issue tracker is a tool to address bugs in Flask-SQLAlchemy itself.
8+
Please use Pallets Discord or Stack Overflow for questions about your
9+
own code.
10+
11+
Ensure your issue is with Flask-SQLAlchemy and not SQLAlchemy itself.
12+
13+
Replace this comment with a clear outline of what the bug is.
14+
-->
15+
16+
<!--
17+
Describe how to replicate the bug.
18+
19+
Include a minimal reproducible example that demonstrates the bug.
20+
Include the full traceback if there was an exception.
21+
-->
22+
23+
<!--
24+
Describe the expected behavior that should have happened but didn't.
25+
-->
26+
27+
Environment:
28+
29+
- Python version:
30+
- Flask-SQLAlchemy version:
31+
- SQLAlchemy version:

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security issue
4+
5+
about: Do not report security issues publicly. Email our security contact.
6+
- name: Questions
7+
url: https://stackoverflow.com/questions/tagged/flask-sqlalchemy?tab=Frequent
8+
about: Search for and ask questions about your code on Stack Overflow.
9+
- name: Questions and discussions
10+
url: https://discord.gg/pallets
11+
about: Discuss questions about your code on our Discord chat.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature for Flask-SQLAlchemy
4+
---
5+
6+
<!--
7+
Replace this comment with a description of what the feature should do.
8+
Include details such as links relevant specs or previous discussions.
9+
-->
10+
11+
<!--
12+
Replace this comment with an example of the problem which this feature
13+
would resolve. Is this problem solvable without changes to Werkzeug,
14+
such as by subclassing or using an extension?
15+
-->

.github/pull_request_template.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!--
2+
Before opening a PR, open a ticket describing the issue or feature the
3+
PR will address. Follow the steps in CONTRIBUTING.rst.
4+
5+
Replace this comment with a description of the change. Describe how it
6+
addresses the linked ticket.
7+
-->
8+
9+
<!--
10+
Link to relevant issues or previous PRs, one per line. Use "fixes" to
11+
automatically close an issue.
12+
-->
13+
14+
- fixes #<issue number>
15+
16+
<!--
17+
Ensure each step in CONTRIBUTING.rst is complete by adding an "x" to
18+
each box below.
19+
20+
If only docs were changed, these aren't relevant and can be removed.
21+
-->
22+
23+
Checklist:
24+
25+
- [ ] Add tests that demonstrate the correct behavior of the change. Tests should fail without the change.
26+
- [ ] Add or update relevant docs, in the docs folder and in code.
27+
- [ ] Add an entry in `CHANGES.rst` summarizing the change and linking to the issue.
28+
- [ ] Add `.. versionchanged::` entries in any relevant code docs.
29+
- [ ] Run `pre-commit` hooks and fix any issues.
30+
- [ ] Run `pytest` and `tox`, no tests failed.

0 commit comments

Comments
 (0)