forked from pallets/click
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update issue templates and contributing guide
- Loading branch information
Showing
3 changed files
with
42 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,19 +7,19 @@ Thank you for considering contributing to Click! | |
Support questions | ||
----------------- | ||
|
||
Please, don't use the issue tracker for this. The issue tracker is a | ||
tool to address bugs and feature requests in Click itself. Use one of | ||
the following resources for questions about using Click 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 Click itself. Use one of the | ||
following resources for questions about using Click 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 [email protected] for long term discussion or larger | ||
issues. | ||
- Ask on `Stack Overflow`_. Search with Google first using: | ||
``site:stackoverflow.com python click {search term, exception message, etc.}`` | ||
|
||
.. _Stack Overflow: https://stackoverflow.com/questions/tagged/python-click?sort=linked | ||
.. _Stack Overflow: https://stackoverflow.com/questions/tagged/python-click?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 Click. If possible, check if this issue is | ||
already fixed in the latest releases or the latest code in the | ||
repository. | ||
- List your Python and Click 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 | ||
|
||
|
@@ -107,14 +107,12 @@ First time setup | |
> env\Scripts\activate | ||
- Install the development dependencies, then install Click in editable | ||
mode. This order is important, otherwise you'll get the wrong | ||
version of Click. | ||
- Install the development dependencies, then install Click in | ||
editable mode. | ||
|
||
.. code-block:: text | ||
$ pip install -r requirements/dev.txt | ||
$ pip install -e . | ||
$ pip install -r requirements/dev.txt && pip install -e . | ||
- Install the pre-commit hooks. | ||
|
||
|
@@ -123,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/click/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 | ||
|
@@ -163,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 | ||
|