Skip to content

Commit 36ab3dd

Browse files
committed
docs: consolidate links in the generated project's CONTRIBUTING.md
1 parent f4ce25e commit 36ab3dd

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

{{cookiecutter.project_name}}/CONTRIBUTING.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
Thank you for your interest in contributing to `{{ cookiecutter.package_name }}`! We welcome bug reports, feature requests, and code contributions that help improve this project.
44

5-
By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
5+
By participating in this project, you are expected to uphold our [Code of Conduct][code-of-conduct].
66

77
## How to Contribute
88

99
### Reporting Bugs
1010

11-
If you find a bug, please open an issue on our [issue tracker](https://github.com/{{ cookiecutter.github_user | lower | replace(' ', '-') }}/{{ cookiecutter.project_name.replace('_', '-') }}/issues) with:
11+
If you find a bug, please open an issue on our [issue tracker][issues] with:
1212

1313
- A clear description of the bug
1414
- Steps to reproduce the issue
@@ -34,7 +34,7 @@ We welcome pull requests! For significant changes, it's best to open an issue fi
3434
### Prerequisites
3535

3636
- Python {{ cookiecutter.min_python_version }}+ (this project supports Python {{ cookiecutter.min_python_version }}-{{ cookiecutter.max_python_version }})
37-
- [uv](https://docs.astral.sh/uv/) for dependency management
37+
- [uv][uv-documentation] for dependency management
3838
- Git for version control
3939

4040
### Setting Up Your Development Environment
@@ -113,12 +113,12 @@ We welcome pull requests! For significant changes, it's best to open an issue fi
113113

114114
This project follows these standards:
115115

116-
- **Code formatting:** [Ruff](https://docs.astral.sh/ruff/) (automatically applied by pre-commit)
116+
- **Code formatting:** [Ruff][ruff-documentation] (automatically applied by pre-commit)
117117
- **Linting:** Ruff with comprehensive rule set
118-
- **Type checking:** [Pyright](https://github.com/microsoft/pyright)
119-
- **Security:** [Bandit](https://bandit.readthedocs.io/) for security linting
120-
- **Commit messages:** [Conventional Commits](https://www.conventionalcommits.org/) format preferred
121-
- **Testing:** [pytest](https://docs.pytest.org/) with good coverage
118+
- **Type checking:** [Pyright][pyright-documentation]
119+
- **Security:** [Bandit][bandit-documentation] for security linting
120+
- **Commit messages:** [Conventional Commits][conventional-commits] format preferred
121+
- **Testing:** [pytest][pytest-documentation] with good coverage
122122

123123
### Testing Guidelines
124124

@@ -180,7 +180,7 @@ uvx nox -t ci # All CI checks
180180

181181
## Getting Help
182182

183-
- Check existing [issues](https://github.com/{{ cookiecutter.github_user | lower | replace(' ', '-') }}/{{ cookiecutter.project_name.replace('_', '-') }}/issues) and [discussions](https://github.com/{{ cookiecutter.github_user | lower | replace(' ', '-') }}/{{ cookiecutter.project_name.replace('_', '-') }}/discussions)
183+
- Check existing [issues][issues] and [discussions][discussions]
184184
- Open a new issue for bugs or feature requests
185185
- Start a discussion for questions or ideas
186186

@@ -190,4 +190,16 @@ Contributors will be recognized in our release notes and documentation. Thank yo
190190

191191
---
192192

193-
*This project was generated from the [cookiecutter-robust-python](https://github.com/56kyle/cookiecutter-robust-python) template.*
193+
*This project was generated from the [cookiecutter-robust-python][cookiecutter-robust-python] template.*
194+
195+
<!-- Reference Links -->
196+
[code-of-conduct]: CODE_OF_CONDUCT.md
197+
[issues]: https://github.com/{{ cookiecutter.github_user | lower | replace(' ', '-') }}/{{ cookiecutter.project_name.replace('_', '-') }}/issues
198+
[discussions]: https://github.com/{{ cookiecutter.github_user | lower | replace(' ', '-') }}/{{ cookiecutter.project_name.replace('_', '-') }}/discussions
199+
[uv-documentation]: https://docs.astral.sh/uv/
200+
[ruff-documentation]: https://docs.astral.sh/ruff/
201+
[pyright-documentation]: https://github.com/microsoft/pyright
202+
[bandit-documentation]: https://bandit.readthedocs.io/
203+
[conventional-commits]: https://www.conventionalcommits.org/
204+
[pytest-documentation]: https://docs.pytest.org/
205+
[cookiecutter-robust-python]: https://github.com/56kyle/cookiecutter-robust-python

0 commit comments

Comments
 (0)