Skip to content

Commit

Permalink
update issue templates and contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
davidism committed Feb 8, 2021
1 parent fbe33ba commit 9cd022f
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 51 deletions.
40 changes: 14 additions & 26 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,24 @@ about: Report a bug in Click (not other projects which depend on Click)
---

<!--
This issue tracker is a tool to address bugs in Click itself.
Please use the #pocoo IRC channel on freenode, the Discord server or
Stack Overflow for general questions about using Flask or issues
not related to Click.
This issue tracker is a tool to address bugs in Click itself. Please use
Pallets Discord or Stack Overflow for questions about your own code.
If you'd like to report a bug in Click, 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.
Replace this comment with a clear outline of what the bug is.
-->

<!--
Describe how to replicate the bug.
### Expected Behavior

Tell us what should happen.

```python
Paste a minimal example that causes the problem.
```

### Actual Behavior

Tell us what happens instead.
Include a minimal reproducible example that demonstrates the bug.
Include the full traceback if there was an exception.
-->

```pytb
Paste the full traceback if there was an exception.
```
<!--
Describe the expected behavior that should have happened but didn't.
-->

### Environment
Environment:

* Python version:
* Click version:
- Python version:
- Click version:
17 changes: 11 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@

<!--
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.
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.
Link to relevant issues or previous PRs, one per line. Use "fixes" to
automatically close an issue.
-->

- Fixes #<issue number>
- fixes #<issue number>

<!--
Ensure each step in CONTRIBUTING.rst is complete by adding an "x" to each box below.
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.
-->

Expand Down
36 changes: 17 additions & 19 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 9cd022f

Please sign in to comment.