diff options
author | David Lord <davidism@gmail.com> | 2021-02-06 22:50:11 -0800 |
---|---|---|
committer | David Lord <davidism@gmail.com> | 2021-02-06 22:51:42 -0800 |
commit | c29aacedef1339e50b3596c42109090810d7be28 (patch) | |
tree | b13fdf893ae059009e0a804bde6c6f3e2240ed60 | |
parent | 94dd6f58cfba26c49d8fdfdae9e6585940ff9e1b (diff) | |
download | markupsafe-c29aacedef1339e50b3596c42109090810d7be28.tar.gz |
add issue templates
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug-report.md | 28 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 11 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature-request.md | 14 | ||||
-rw-r--r-- | .github/pull_request_template.md | 30 |
4 files changed, 83 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..2ad0a4c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,28 @@ +--- +name: Bug report +about: Report a bug in MarkupSafe (not other projects which depend on MarkupSafe) +--- + +<!-- +This issue tracker is a tool to address bugs in Markupsafe 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: +- MarkupSafe version: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a1e262f --- /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/ + 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 new file mode 100644 index 0000000..d399b1f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Suggest a new feature for MarkupSafe +--- + +<!-- +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 MarkupSafe? +--> diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..29fd35f --- /dev/null +++ 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. |