docs: refine CONTRIBUTIONS.md - #32
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository’s contributor documentation to reflect current local workflows and project layout, aligning guidance with the monorepo’s tooling (pnpm + demo app) and versioning approach.
Changes:
- Refines the development command list (adds
pnpm demo, clarifiespnpm test/pnpm dev). - Simplifies and rewords the versioning/changesets guidance.
- Updates the project structure section to list packages and the demo app.
Comments suppressed due to low confidence (1)
CONTRIBUTING.md:26
- CI runs formatting in check mode (see
mise.toml:oxfmt = "pnpm oxfmt --check"). Since this section is positioned as the pre-commit commands, consider documentingpnpm oxfmt --check(and optionallypnpm oxfmtto apply fixes) so contributors can match CI locally.
# Lint and format code
pnpm oxlint
pnpm oxlint --fix
pnpm oxfmt
|
|
||
| > Please provide a description of the intended change in the PR. | ||
|
|
||
| > Commit messages should follow [convential commit standard](https://www.conventionalcommits.org/en/v1.0.0/) |
There was a problem hiding this comment.
Typo in the Conventional Commits line: "convential" should be "conventional" (and typically phrased as "the Conventional Commits standard").
Suggested change
| > Commit messages should follow [convential commit standard](https://www.conventionalcommits.org/en/v1.0.0/) | |
| > Commit messages should follow the [Conventional Commits standard](https://www.conventionalcommits.org/en/v1.0.0/) |
| 4. Ensure code passes linting: `pnpm run lint` | ||
| 4. Ensure code passes linting: `pnpm oxlint` | ||
| 5. Run tests: `pnpm test` | ||
| 6. [optional] add changeset |
There was a problem hiding this comment.
The checklist marks adding a changeset as "[optional]", but the Versioning section below says changesets are always required for many code changes. Consider making step 6 conditional (e.g., required when modifying a published package) to avoid contradictory guidance.
Suggested change
| 6. [optional] add changeset | |
| 6. If your change affects a published package (see Versioning below), add a changeset: `pnpm changeset` |
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.
Closes #25