Skip to content

Commit 2d61aa8

Browse files
authored
Merge pull request pallets-eco#730 from lbeaufort/728-add-issue-template
Add issue template
2 parents 7fa2ad5 + 704e6f1 commit 2d61aa8

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
**This issue tracker is a tool to address bugs and feature requests in
2+
Flask-SQLAlchemy itself. Please use the [#pocoo IRC channel on freenode](http://flask.pocoo.org/community/irc/)
3+
or [Stack Overflow](https://stackoverflow.com/questions/tagged/flask-sqlalchemy?sort=linked) for general questions about using Flask-SQLAlchemy
4+
or issues not related to Flask-SQLAlchemy.**
5+
6+
If you'd like to report a issue in Flask-SQLAlchemy, fill out the template below.
7+
Provide any extra information that may be useful / related to your problem.
8+
Ideally, create a [minimal, complete, and verifiable example (MCVE)](https://stackoverflow.com/help/mcve),
9+
which helps us understand the problem and helps check that it is not caused
10+
by something in your code.
11+
12+
Flask-SQLAlchemy is a thin wrapper that combines [Flask](https://github.com/pallets/flask) and [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy). Please
13+
make sure your issue is **actually with Flask-SQLAlchemy and not SQLAlchemy** before
14+
submitting. Consider checking the traceback to see if the error is coming from SQLAlchemy,
15+
or checking if your issue has already been reported as a [SQLAlchemy issue on GitHub](https://github.com/sqlalchemy/sqlalchemy/issues).
16+
17+
Also, please be kind - this project is maintained by volunteers. We appreciate
18+
you taking the time to provide the information needed to address your issue.
19+
20+
---
21+
22+
### Expected Behavior
23+
24+
Tell us what should happen.
25+
26+
```python
27+
Paste a minimal example that causes the problem.
28+
```
29+
30+
### Actual Behavior
31+
32+
Tell us what happens instead.
33+
34+
```pytb
35+
Paste the full traceback if there was an exception.
36+
```
37+
38+
### Environment
39+
40+
* Operating system:
41+
* Python version:
42+
* Flask-SQLAlchemy version:
43+
* SQLAlchemy version:
44+
45+

0 commit comments

Comments
 (0)