Repository navigation
Add CONTRIBUTING.md: the CI checks to run locally before opening a pull request - #518
Draft
alexshchur wants to merge 2 commits into
Draft
alexshchur wants to merge 2 commits into
alexshchur wants to merge 2 commits into
Conversation
|
Contributor
|
Vercel previews (commit
|
This branch was successfully deployed
This file contains hidden or 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
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.
Pull requests from forks wait for a maintainer to approve their CI run, so a contributor can't see a failed Formatting check on their own until someone clicks. This adds a short
CONTRIBUTING.mdthat lists the fiveChecksjobs with the command behind each one, so they can run the same checks locally before pushing.It also covers setup (pnpm, Foundry for lint and types),
pnpm test, when a changeset is needed (pointing at.memory/changesets.mdfor the writing rules), and a few expectations for the PR itself.Draft: wording is open for review. No changeset: repo docs only.