Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Initial Setup Documentation #33

Open
5 of 8 tasks
phinate opened this issue May 22, 2024 · 0 comments
Open
5 of 8 tasks

Improve Initial Setup Documentation #33

phinate opened this issue May 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@phinate
Copy link
Collaborator

phinate commented May 22, 2024

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

  • Create or expand README to include:
    • Setting up a virtual environment.
    • Adding dependencies.
    • Using pre-commit hooks.
  • Clearly reference or include relevant parts from CONTRIBUTING.md.
@phinate phinate added the documentation Improvements or additions to documentation label May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant