update issue templates
This commit is contained in:
parent
bfd4dc6d30
commit
571e638e2a
6 changed files with 83 additions and 45 deletions
29
.github/ISSUE_TEMPLATE.md
vendored
29
.github/ISSUE_TEMPLATE.md
vendored
|
|
@ -1,29 +0,0 @@
|
|||
<!-- **This issue tracker is a tool to address bugs in Flask itself.
|
||||
Please use the Pallets Discord or Stack Overflow for general questions
|
||||
about using Flask or issues not related to Flask.** -->
|
||||
|
||||
<!-- If you'd like to report a bug in Flask, fill out the template below. Provide
|
||||
any extra information that may be useful / related to your problem.
|
||||
Ideally, create an [MCVE](https://stackoverflow.com/help/mcve), which helps us
|
||||
understand the problem and helps check that it is not caused by something in
|
||||
your code. -->
|
||||
|
||||
### Expected Behavior
|
||||
<!-- Tell us what should happen. -->
|
||||
|
||||
```python
|
||||
# Paste a minimal example that causes the problem.
|
||||
```
|
||||
|
||||
### Actual Behavior
|
||||
<!-- Tell us what happens instead. -->
|
||||
|
||||
```pytb
|
||||
Paste the full traceback if there was an exception.
|
||||
```
|
||||
|
||||
### Environment
|
||||
|
||||
* Python version:
|
||||
* Flask version:
|
||||
* Werkzeug version:
|
||||
27
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
27
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Report a bug in Flask (not other projects which depend on Flask)
|
||||
---
|
||||
|
||||
<!--
|
||||
This issue tracker is a tool to address bugs in Flask 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:
|
||||
- Flask version:
|
||||
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -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?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.
|
||||
15
.github/ISSUE_TEMPLATE/feature-request.md
vendored
Normal file
15
.github/ISSUE_TEMPLATE/feature-request.md
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest a new feature for Flask
|
||||
---
|
||||
|
||||
<!--
|
||||
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 Flask, such
|
||||
as by subclassing or using an extension?
|
||||
-->
|
||||
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -1,16 +0,0 @@
|
|||
Describe what this patch does to fix the issue.
|
||||
|
||||
Link to any relevant issues or pull requests.
|
||||
|
||||
<!--
|
||||
Commit checklist:
|
||||
|
||||
* add tests that fail without the patch
|
||||
* ensure all tests pass with ``pytest``
|
||||
* add documentation to the relevant docstrings or pages
|
||||
* add ``versionadded`` or ``versionchanged`` directives to relevant docstrings
|
||||
* add a changelog entry if this patch changes code
|
||||
|
||||
Tests, coverage, and docs will be run automatically when you submit the pull
|
||||
request, but running them yourself can save time.
|
||||
-->
|
||||
30
.github/pull_request_template.md
vendored
Normal file
30
.github/pull_request_template.md
vendored
Normal file
|
|
@ -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.
|
||||
Loading…
Add table
Add a link
Reference in a new issue