Improve Initial Setup Documentation - Githubissues

alan-turing-institute / python-project-template

15 stars 3 forks source link

Improve Initial Setup Documentation #33

Open phinate opened 6 months ago

phinate commented 6 months ago

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.