Skip to content

Commit 71d81c6

Browse files
committed
update contributing guide
1 parent f009a00 commit 71d81c6

2 files changed

Lines changed: 14 additions & 10 deletions

File tree

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ contact_links:
77
url: https://stackoverflow.com/questions/tagged/Jinja?tab=Frequent
88
about: Search for and ask questions about your code on Stack Overflow.
99
- name: Questions and discussions
10-
url: https://discord.gg/t6rrQZH
10+
url: https://discord.gg/pallets
1111
about: Discuss questions about your code on our Discord chat.

CONTRIBUTING.rst

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ Thank you for considering contributing to Jinja!
77
Support questions
88
-----------------
99

10-
Please, don't use the issue tracker for this. The issue tracker is a
10+
Please don't use the issue tracker for this. The issue tracker is a
1111
tool to address bugs and feature requests in Jinja itself. Use one of
1212
the following resources for questions about using Jinja or issues with
1313
your own code:
1414

1515
- The ``#get-help`` channel on our Discord chat:
16-
https://discord.gg/t6rrQZH
16+
https://discord.gg/pallets
1717
- The mailing list [email protected] for long term discussion or larger
1818
issues.
1919
- Ask on `Stack Overflow`_. Search with Google first using:
2020
``site:stackoverflow.com jinja {search term, exception message, etc.}``
2121

22-
.. _Stack Overflow: https://stackoverflow.com/questions/tagged/jinja?sort=linked
22+
.. _Stack Overflow: https://stackoverflow.com/questions/tagged/jinja?tab=Frequent
2323

2424

2525
Reporting issues
@@ -107,11 +107,15 @@ First time setup
107107
108108
> env\Scripts\activate
109109
110-
- Install Jinja in editable mode with development dependencies.
110+
- Install the development dependencies, then install Jinja in editable
111+
mode.
111112

112113
.. code-block:: text
113114
114-
$ pip install -e . -r requirements/dev.txt
115+
$ pip install -r requirements/dev.txt
116+
$ pip install -e .
117+
# or on one line:
118+
$ pip install -r requirements/dev.txt && pip install -e .
115119
116120
- Install the pre-commit hooks.
117121

@@ -120,11 +124,11 @@ First time setup
120124
$ pre-commit install
121125
122126
.. _latest version of git: https://git-scm.com/downloads
123-
.. _username: https://help.github.com/en/articles/setting-your-username-in-git
124-
.. _email: https://help.github.com/en/articles/setting-your-commit-email-address-in-git
127+
.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git
128+
.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address
125129
.. _GitHub account: https://github.com/join
126130
.. _Fork: https://github.com/pallets/jinja/fork
127-
.. _Clone: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork
131+
.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork
128132

129133

130134
Start coding
@@ -160,7 +164,7 @@ Start coding
160164
$ git push --set-upstream fork your-branch-name
161165
162166
.. _committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes
163-
.. _create a pull request: https://help.github.com/en/articles/creating-a-pull-request
167+
.. _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request
164168

165169

166170
Running the tests

0 commit comments

Comments
 (0)