diff options
author | David Lord <davidism@gmail.com> | 2021-02-08 12:04:19 -0800 |
---|---|---|
committer | David Lord <davidism@gmail.com> | 2021-02-08 12:04:19 -0800 |
commit | 6425a65643646e4229c2f31406ad7210e8537fcb (patch) | |
tree | cb9c2577512b61c924213357ac68e1fce655f3b9 | |
parent | 08e8ded92c29c34f5220300c83b8267d890b4545 (diff) | |
download | itsdangerous-6425a65643646e4229c2f31406ad7210e8537fcb.tar.gz |
update links and dev install
-rw-r--r-- | CONTRIBUTING.rst | 38 |
1 files changed, 20 insertions, 18 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index e3bc937..77e97e8 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,5 +1,5 @@ How to contribute to ItsDangerous -============================= +================================= Thank you for considering contributing to ItsDangerous! @@ -7,19 +7,19 @@ Thank you for considering contributing to ItsDangerous! Support questions ----------------- -Please, don't use the issue tracker for this. The issue tracker is a -tool to address bugs and feature requests in ItsDangerous itself. Use one of -the following resources for questions about using ItsDangerous or issues -with your own code: +Please don't use the issue tracker for this. The issue tracker is a +tool to address bugs and feature requests in ItsDangerous itself. Use +one of the following resources for questions about using ItsDangerous or +issues with your own code: - The ``#get-help`` channel on our Discord chat: - https://discord.gg/t6rrQZH + https://discord.gg/pallets - The mailing list flask@python.org for long term discussion or larger issues. - Ask on `Stack Overflow`_. Search with Google first using: ``site:stackoverflow.com itsdangerous {search term, exception message, etc.}`` -.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?sort=linked +.. _Stack Overflow: https://stackoverflow.com/questions/tagged/itsdangerous?tab=Frequent Reporting issues @@ -33,9 +33,9 @@ Include the following information in your post: your own code. - Describe what actually happened. Include the full traceback if there was an exception. -- List your Python and ItsDangerous versions. If possible, check if this - issue is already fixed in the latest releases or the latest code in - the repository. +- List your Python and ItsDangerous versions. If possible, check if + this issue is already fixed in the latest releases or the latest + code in the repository. .. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example @@ -78,7 +78,8 @@ First time setup $ git config --global user.email 'your email' - Make sure you have a `GitHub account`_. -- Fork ItsDangerous to your GitHub account by clicking the `Fork`_ button. +- Fork ItsDangerous to your GitHub account by clicking the `Fork`_ + button. - `Clone`_ the main repository locally. .. code-block:: text @@ -107,11 +108,12 @@ First time setup > env\Scripts\activate -- Install ItsDangerous in editable mode with development dependencies. +- Install the development dependencies, then install ItsDangerous in + editable mode. .. code-block:: text - $ pip install -e . -r requirements/dev.txt + $ pip install -r requirements/dev.txt && pip install -e . - Install the pre-commit hooks. @@ -120,11 +122,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/itsdangerous/fork -.. _Clone: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork +.. _Fork: https://github.com/pallets/jinja/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 +162,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 |