-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add pre-commit GitHub workflow, add "Getting started" docs #8
Conversation
@machikoyasuda This PR is ready for your review! |
@angela-tran Could you add the basic repo set up command instructions? I think I can guess them, but I don't want to mess it up and want to set it up as you've intended! |
@machikoyasuda Sure thing. Just to make sure I understand, do you mean instructions kind of like these: https://docs.calitp.org/eligibility-server/#getting-started-with-the-app? |
yes! just the basic commands to clone, build and run the container |
@machikoyasuda I added a home page and a "Getting started" page to the docs, which also means we can close #9 🎉 (if approved) Here is the rendered output that I see locally for getting started: You should be able to just open the devcontainer in VS Code without having to build anything beforehand. |
713e944
to
e2b9c62
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once @thekaveman's edits are added, I'm good with this PR!
I ran this locally with the instructions and tested adding a commit that doesn't pass pre-commit rules:
and it worked great.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
Similiar to cal-itp/eligibility-server#14