alan-turing-institute / alan-turing-institute/python-project-template
Improve Initial Setup Documentation
Open
documentation
- Dominant language
- Python
- Stars
- 33
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Description
## Initializing Git Repository
- [ ] Add detailed instructions for initializing the local git repository.
- [ ] Provide steps for creating and pushing the repository to GitHub.
- [ ] Consider automating the git initialization and GitHub push steps if we can.
## Usage Documentation
Via #40
- [x] Create or expand README to include:
- [x] Setting up a virtual environment.
- [x] Adding dependencies.
- [x] Using pre-commit hooks.
- [x] Clearly reference or include relevant parts from `CONTRIBUTING.md`.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.