Skip to content

Commit 5a0facc

Browse files
committed
consistent naming in README
1 parent 0f9f3be commit 5a0facc

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,17 @@ A basic template for building Python packages.
3838
- Check "Require branches to be up to date before merging".
3939
- Then type in `autoformat`, `static-type-checking`, `linting`, `unit-tests`.
4040
- Check "Do not allow bypassing the above settings".
41-
9. **Set up repository settings** in `https://github.com/$MYGITUSER$/$MYREPO/settings`:
41+
9. **Set up repository settings** in `https://github.com/<USER>/<NAME>/settings`:
4242
- Check "Allow auto-merge".
4343
- Check "Automatically delete head branches".
4444
- Uncheck "Allow merge commits".
4545
- Uncheck "Allow rebase merging".
46-
10. **Set up contributor settings** to lower the barrier for external contributions. In `https://github.com/$MYGITUSER$/$MYREPO/settings/actions`:
46+
10. **Set up contributor settings** to lower the barrier for external contributions. In `https://github.com/<USER>/<NAME>/settings/actions`:
4747
- Update "Fork pull request workflows from outside collaborators" to "Require approval for first-time contributors who are new to GitHub".
4848

4949

5050
## Notes
5151
- Continuous integration with GitHub Actions only works if you have a public repository or an Enterprise account. You can still run checks locally with `./run_ci_checks.sh` regardless.
52-
- You can include your repository as a dependency if it's hosted on GitHub. For example, alongside requirements like `numpy` or `matplotlib` in a `pyproject.toml` or `requirements.txt` or `setup.py`, you can list `"YOUR-PACKAGE-NAME@git+https://github.com/YOUR-GITHUB-USERNAME/YOUR-REPO-NAME.git"`.
52+
- You can include your repository as a dependency if it's hosted on GitHub. For example, alongside requirements like `numpy` or `matplotlib` in a `pyproject.toml` or `requirements.txt` or `setup.py`, you can list `"<PACKAGE-NAME>@git+https://github.com/<USER>/<NAME>.git"`.
5353
- Feel free to open pull requests to improve this repository.
5454
- You can use this code and modify it in any way without any attributions or acknowledgements (see `LICENSE`).

0 commit comments

Comments
 (0)