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

Add pre-commit GitHub workflow, add "Getting started" docs #8

Merged
merged 7 commits into from
Nov 18, 2021

Conversation

angela-tran
Copy link
Member

@angela-tran angela-tran commented Nov 16, 2021

Similiar to cal-itp/eligibility-server#14

@angela-tran angela-tran self-assigned this Nov 16, 2021
@angela-tran angela-tran marked this pull request as draft November 16, 2021 17:21
@angela-tran angela-tran marked this pull request as ready for review November 16, 2021 18:48
@angela-tran
Copy link
Member Author

@machikoyasuda This PR is ready for your review!

@thekaveman thekaveman added this to the November 2021 milestone Nov 16, 2021
@machikoyasuda
Copy link
Member

@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!

@angela-tran
Copy link
Member Author

@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?

@machikoyasuda
Copy link
Member

@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

@angela-tran
Copy link
Member Author

angela-tran commented Nov 16, 2021

@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:
image

You should be able to just open the devcontainer in VS Code without having to build anything beforehand.

@angela-tran angela-tran changed the title Add pre-commit GitHub workflow Add pre-commit GitHub workflow, add "Getting started" docs Nov 16, 2021
@angela-tran angela-tran force-pushed the feat/setup-pre-commit-action branch from 713e944 to e2b9c62 Compare November 16, 2021 22:40
.vscode/settings.json Show resolved Hide resolved
Copy link
Member

@machikoyasuda machikoyasuda left a 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:
image
and it worked great.

.vscode/settings.json Show resolved Hide resolved
Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create home page for Eligibility API docs
3 participants