-
-
Notifications
You must be signed in to change notification settings - Fork 103
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
contributing documentation overhaul #517
Merged
benjie
merged 11 commits into
graphile:main
from
jcgsville:chandler/update-docker-compose-docs
Dec 5, 2024
Merged
contributing documentation overhaul #517
benjie
merged 11 commits into
graphile:main
from
jcgsville:chandler/update-docker-compose-docs
Dec 5, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
benjie
reviewed
Dec 4, 2024
jcgsville
changed the title
WIP: update contributing docs with correct docker compose commands & yarn 1.x
update contributing docs with correct docker compose commands & yarn 1.x
Dec 5, 2024
jcgsville
changed the title
update contributing docs with correct docker compose commands & yarn 1.x
contributing documentation overhaul
Dec 5, 2024
5 tasks
Thanks for the additions and corrections, @benjie |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Did an overhaul on Contributing docs to make them up-to-date with the latest changes and provide info on the things I had to figure out myself.
I also fixed the
yarn website
script, which was not working, and I added theyarn cli
script. I'm not deeply opinionated about having yarn cli, so if you think it's not useful enough to add to package.json scripts, I'm happy to update it and update the docs.Also, when I ran docker compose I got this warning, so I removed the version line as instructed.
Checklist
yarn lint:fix
passes.