Skip to content

Add CONTRIBUTING.md: the CI checks to run locally before opening a pull request - #518

Draft
alexshchur wants to merge 2 commits into
masterfrom
docs/contributing
Draft

alexshchur wants to merge 2 commits into
masterfrom
docs/contributing

Conversation

@alexshchur

Copy link
Copy Markdown
Contributor

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.md that lists the five Checks jobs 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.md for the writing rules), and a few expectations for the PR itself.

Draft: wording is open for review. No changeset: repo docs only.

@changeset-bot

changeset-bot Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 640e288

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions

github-actions Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Vercel previews (commit 640e288)

Project Deployment Updated
docs Visit Preview Nov 9, 2026 13:11 UTC
react Visit Preview Nov 9, 2026 13:12 UTC

This branch was successfully deployed

2 active deployments
Preview – react — 640e288d Deployed Nov 9, 2026 by github-actions[bot]
Preview – docs — 640e288d Deployed Nov 9, 2026 by github-actions[bot]
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.

1 participant