Merge pull request #183 from pallets/update-project

add issue templates, update requirements

13 files changed, 133 insertions, 62 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.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index b2893ca..b72b50c 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -5,7 +5,7 @@ repos:
       - id: pyupgrade
         args: ["--py36-plus"]
   - repo: https://github.com/asottile/reorder_python_imports
-    rev: v2.3.6
+    rev: v2.4.0
     hooks:
       - id: reorder-python-imports
         args: ["--application-directories", "src"]
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index ca21906..49f91de 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,5 +1,5 @@
 How to contribute to MarkupSafe
-=============================
+===============================
 
 Thank you for considering contributing to MarkupSafe!
 
@@ -7,8 +7,8 @@ Thank you for considering contributing to MarkupSafe!
 Support questions
 -----------------
 
-Please, don't use the issue tracker for this. The issue tracker is a
-tool to address bugs and feature requests in MarkupSafe itself. Use one of
+Please don't use the issue tracker for this. The issue tracker is a tool
+to address bugs and feature requests in MarkupSafe itself. Use one of
 the following resources for questions about using MarkupSafe or issues
 with your own code:
 
@@ -21,6 +21,7 @@ with your own code:
 
 .. _Stack Overflow: https://stackoverflow.com/search?tab=relevance&q=markupsafe
 
+
 Reporting issues
 ----------------
 
@@ -120,11 +121,11 @@ First time setup
         $ pre-commit install
 
 .. _latest version of git: https://git-scm.com/downloads
-.. _username: https://help.github.com/en/articles/setting-your-username-in-git
-.. _email: https://help.github.com/en/articles/setting-your-commit-email-address-in-git
+.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git
+.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address
 .. _GitHub account: https://github.com/join
 .. _Fork: https://github.com/pallets/markupsafe/fork
-.. _Clone: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork
+.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork
 
 
 Start coding
@@ -160,7 +161,7 @@ Start coding
         $ git push --set-upstream fork your-branch-name
 
 .. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes
-.. _create a pull request: https://help.github.com/en/articles/creating-a-pull-request
+.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request
 
 
 Running the tests
diff --git a/requirements/dev.in b/requirements/dev.in
index c854000..2588467 100644
--- a/requirements/dev.in
+++ b/requirements/dev.in
@@ -1,5 +1,6 @@
 -r docs.in
 -r tests.in
+-r typing.in
 pip-tools
 pre-commit
 tox
diff --git a/requirements/dev.txt b/requirements/dev.txt
index 5c91fe1..adad6b5 100644
--- a/requirements/dev.txt
+++ b/requirements/dev.txt
@@ -8,19 +8,19 @@ alabaster==0.7.12
     # via sphinx
 appdirs==1.4.4
     # via virtualenv
-attrs==19.3.0
+attrs==20.3.0
     # via pytest
 babel==2.9.0
     # via sphinx
 certifi==2020.12.5
     # via requests
-cfgv==3.1.0
+cfgv==3.2.0
     # via pre-commit
 chardet==4.0.0
     # via requests
 click==7.1.2
     # via pip-tools
-distlib==0.3.0
+distlib==0.3.1
     # via virtualenv
 docutils==0.16
     # via sphinx
@@ -28,21 +28,25 @@ filelock==3.0.12
     # via
     #   tox
     #   virtualenv
-identify==1.4.16
+identify==1.5.13
     # via pre-commit
 idna==2.10
     # via requests
 imagesize==1.2.0
     # via sphinx
-iniconfig==1.0.0
+iniconfig==1.1.1
     # via pytest
-jinja2==2.11.2
+jinja2==2.11.3
     # via sphinx
 markupsafe==1.1.1
     # via jinja2
-nodeenv==1.3.5
+mypy-extensions==0.4.3
+    # via mypy
+mypy==0.800
+    # via -r requirements/typing.in
+nodeenv==1.5.0
     # via pre-commit
-packaging==20.4
+packaging==20.9
     # via
     #   pallets-sphinx-themes
     #   pytest
@@ -56,9 +60,9 @@ pluggy==0.13.1
     # via
     #   pytest
     #   tox
-pre-commit==2.10.0
+pre-commit==2.10.1
     # via -r requirements/dev.in
-py==1.9.0
+py==1.10.0
     # via
     #   pytest
     #   tox
@@ -68,15 +72,14 @@ pyparsing==2.4.7
     # via packaging
 pytest==6.2.2
     # via -r requirements/tests.in
-pytz==2020.5
+pytz==2021.1
     # via babel
-pyyaml==5.3.1
+pyyaml==5.4.1
     # via pre-commit
 requests==2.25.1
     # via sphinx
 six==1.15.0
     # via
-    #   packaging
     #   tox
     #   virtualenv
 snowballstemmer==2.1.0
@@ -103,16 +106,20 @@ sphinxcontrib-qthelp==1.0.3
     # via sphinx
 sphinxcontrib-serializinghtml==1.1.4
     # via sphinx
-toml==0.10.1
+toml==0.10.2
     # via
     #   pre-commit
     #   pytest
     #   tox
-tox==3.21.3
+tox==3.21.4
     # via -r requirements/dev.in
+typed-ast==1.4.2
+    # via mypy
+typing-extensions==3.7.4.3
+    # via mypy
 urllib3==1.26.3
     # via requests
-virtualenv==20.0.21
+virtualenv==20.4.2
     # via
     #   pre-commit
     #   tox
diff --git a/requirements/docs.txt b/requirements/docs.txt
index 3152631..7178f56 100644
--- a/requirements/docs.txt
+++ b/requirements/docs.txt
@@ -6,39 +6,37 @@
 #
 alabaster==0.7.12
     # via sphinx
-babel==2.8.0
+babel==2.9.0
     # via sphinx
-certifi==2020.4.5.1
+certifi==2020.12.5
     # via requests
-chardet==3.0.4
+chardet==4.0.0
     # via requests
 docutils==0.16
     # via sphinx
-idna==2.9
+idna==2.10
     # via requests
 imagesize==1.2.0
     # via sphinx
-jinja2==2.11.2
+jinja2==2.11.3
     # via sphinx
 markupsafe==1.1.1
     # via jinja2
-packaging==20.4
+packaging==20.9
     # via
     #   pallets-sphinx-themes
     #   sphinx
 pallets-sphinx-themes==1.2.3
     # via -r requirements/docs.in
-pygments==2.6.1
+pygments==2.7.4
     # via sphinx
 pyparsing==2.4.7
     # via packaging
-pytz==2020.1
+pytz==2021.1
     # via babel
-requests==2.23.0
+requests==2.25.1
     # via sphinx
-six==1.15.0
-    # via packaging
-snowballstemmer==2.0.0
+snowballstemmer==2.1.0
     # via sphinx
 sphinx-issues==1.2.0
     # via -r requirements/docs.in
@@ -62,7 +60,7 @@ sphinxcontrib-qthelp==1.0.3
     # via sphinx
 sphinxcontrib-serializinghtml==1.1.4
     # via sphinx
-urllib3==1.25.9
+urllib3==1.26.3
     # via requests
 
 # The following packages are considered to be unsafe in a requirements file:
diff --git a/requirements/tests.txt b/requirements/tests.txt
index 3cc97a6..43d6aba 100644
--- a/requirements/tests.txt
+++ b/requirements/tests.txt
@@ -4,21 +4,19 @@
 #
 #    pip-compile requirements/tests.in
 #
-attrs==19.3.0
+attrs==20.3.0
     # via pytest
-iniconfig==1.0.0
+iniconfig==1.1.1
     # via pytest
-packaging==20.4
+packaging==20.9
     # via pytest
 pluggy==0.13.1
     # via pytest
-py==1.9.0
+py==1.10.0
     # via pytest
 pyparsing==2.4.7
     # via packaging
 pytest==6.2.2
     # via -r requirements/tests.in
-six==1.15.0
-    # via packaging
-toml==0.10.1
+toml==0.10.2
     # via pytest
diff --git a/requirements/typing.in b/requirements/typing.in
index d76706e..f0aa93a 100644
--- a/requirements/typing.in
+++ b/requirements/typing.in
@@ -1,2 +1 @@
 mypy
-pytest
diff --git a/requirements/typing.txt b/requirements/typing.txt
index c67c7a0..2530301 100644
--- a/requirements/typing.txt
+++ b/requirements/typing.txt
@@ -4,26 +4,10 @@
 #
 #    pip-compile requirements/typing.in
 #
-attrs==20.3.0
-    # via pytest
-iniconfig==1.1.1
-    # via pytest
 mypy-extensions==0.4.3
     # via mypy
 mypy==0.800
     # via -r requirements/typing.in
-packaging==20.9
-    # via pytest
-pluggy==0.13.1
-    # via pytest
-py==1.10.0
-    # via pytest
-pyparsing==2.4.7
-    # via packaging
-pytest==6.2.2
-    # via -r requirements/typing.in
-toml==0.10.2
-    # via pytest
 typed-ast==1.4.2
     # via mypy
 typing-extensions==3.7.4.3
diff --git a/setup.cfg b/setup.cfg
index 26ebc94..59c0533 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -70,7 +70,7 @@ ignore =
 max-line-length = 80
 
 [mypy]
-files = src/
+files = src/markupsafe
 disallow_subclassing_any = true
 disallow_untyped_calls = true
 disallow_untyped_defs = true