You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ by setting the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
46
46
- Git (1.7.x or newer)
47
47
- Python >= 3.7
48
48
49
-
The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`.
49
+
The list of dependencies are listed in [`./requirements.txt`](https://github.com/gitpython-developers/GitPython/blob/main/requirements.txt) and [`./test-requirements.txt`](https://github.com/gitpython-developers/GitPython/blob/main/test-requirements.txt).
50
50
The installer takes care of installing them for you.
51
51
52
52
### INSTALL
@@ -180,7 +180,7 @@ Style and formatting checks, and running tests on all the different supported Py
180
180
181
181
#### Configuration files
182
182
183
-
Specific tools are all configured in the `./pyproject.toml` file:
183
+
Specific tools are all configured in the [`./pyproject.toml`](https://github.com/gitpython-developers/GitPython/blob/main/pyproject.toml) file:
184
184
185
185
-`pytest` (test runner)
186
186
-`coverage.py` (code coverage)
@@ -189,9 +189,9 @@ Specific tools are all configured in the `./pyproject.toml` file:
189
189
190
190
Orchestration tools:
191
191
192
-
- Configuration for `pre-commit` is in the `./.pre-commit-config.yaml` file.
193
-
- Configuration for `tox` is in `./tox.ini`.
194
-
- Configuration for GitHub Actions (CI) is in files inside `./.github/workflows/`.
192
+
- Configuration for `pre-commit` is in the [`./.pre-commit-config.yaml`](https://github.com/gitpython-developers/GitPython/blob/main/.pre-commit-config.yaml) file.
193
+
- Configuration for `tox` is in [`./tox.ini`](https://github.com/gitpython-developers/GitPython/blob/main/tox.ini).
194
+
- Configuration for GitHub Actions (CI) is in files inside [`./.github/workflows/`](https://github.com/gitpython-developers/GitPython/tree/main/.github/workflows).
195
195
196
196
### Contributions
197
197
@@ -212,8 +212,8 @@ Please have a look at the [contributions file][contributing].
212
212
213
213
### How to make a new release
214
214
215
-
1. Update/verify the **version** in the `VERSION` file.
216
-
2. Update/verify that the `doc/source/changes.rst` changelog file was updated. It should include a link to the forthcoming release page: `https://github.com/gitpython-developers/GitPython/releases/tag/<version>`
215
+
1. Update/verify the **version** in the [`VERSION`](https://github.com/gitpython-developers/GitPython/blob/main/VERSION) file.
216
+
2. Update/verify that the [`doc/source/changes.rst`](https://github.com/gitpython-developers/GitPython/blob/main/doc/source/changes.rst) changelog file was updated. It should include a link to the forthcoming release page: `https://github.com/gitpython-developers/GitPython/releases/tag/<version>`
217
217
3. Commit everything.
218
218
4. Run `git tag -s <version>` to tag the version in Git.
219
219
5._Optionally_ create and activate a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment). (Then the next step can install `build` and `twine`.)
@@ -240,7 +240,7 @@ Please have a look at the [contributions file][contributing].
240
240
241
241
[3-Clause BSD License](https://opensource.org/license/bsd-3-clause/), also known as the New BSD License. See the [LICENSE file][license].
242
242
243
-
One file exclusively used for fuzz testing is subject to [a separate license, detailed here](./fuzzing/README.md#license).
243
+
One file exclusively used for fuzz testing is subject to [a separate license, detailed here](https://github.com/gitpython-developers/GitPython/blob/main/fuzzing/README.md#license).
244
244
This file is not included in the wheel or sdist packages published by the maintainers of GitPython.
0 commit comments