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
+3-3
Original file line number
Diff line number
Diff line change
@@ -38,17 +38,17 @@ A basic template for building Python packages.
38
38
- Check "Require branches to be up to date before merging".
39
39
- Then type in `autoformat`, `static-type-checking`, `linting`, `unit-tests`.
40
40
- 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`:
42
42
- Check "Allow auto-merge".
43
43
- Check "Automatically delete head branches".
44
44
- Uncheck "Allow merge commits".
45
45
- 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`:
47
47
- Update "Fork pull request workflows from outside collaborators" to "Require approval for first-time contributors who are new to GitHub".
48
48
49
49
50
50
## Notes
51
51
- 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"`.
53
53
- Feel free to open pull requests to improve this repository.
54
54
- You can use this code and modify it in any way without any attributions or acknowledgements (see `LICENSE`).
0 commit comments