Skip to content

Commit 57bbea9

Browse files
authored
Merge pull request #2098 from Timour-Ilyas/update-readme-urls
DOC: README Add urls and updated a relative url
2 parents 7d06b14 + acc6a8c commit 57bbea9

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ by setting the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
4646
- Git (1.7.x or newer)
4747
- Python >= 3.7
4848

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).
5050
The installer takes care of installing them for you.
5151

5252
### INSTALL
@@ -180,7 +180,7 @@ Style and formatting checks, and running tests on all the different supported Py
180180

181181
#### Configuration files
182182

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:
184184

185185
- `pytest` (test runner)
186186
- `coverage.py` (code coverage)
@@ -189,9 +189,9 @@ Specific tools are all configured in the `./pyproject.toml` file:
189189

190190
Orchestration tools:
191191

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).
195195

196196
### Contributions
197197

@@ -212,8 +212,8 @@ Please have a look at the [contributions file][contributing].
212212

213213
### How to make a new release
214214

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>`
217217
3. Commit everything.
218218
4. Run `git tag -s <version>` to tag the version in Git.
219219
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].
240240

241241
[3-Clause BSD License](https://opensource.org/license/bsd-3-clause/), also known as the New BSD License. See the [LICENSE file][license].
242242

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).
244244
This file is not included in the wheel or sdist packages published by the maintainers of GitPython.
245245

246246
[contributing]: https://github.com/gitpython-developers/GitPython/blob/main/CONTRIBUTING.md

0 commit comments

Comments
 (0)