Skip to content

docs: refine CONTRIBUTIONS.md - #32

Merged
vinpogo merged 2 commits into
mainfrom
docs/contributing-guide
Feb 21, 2026
Merged

docs: refine CONTRIBUTIONS.md#32
vinpogo merged 2 commits into
mainfrom
docs/contributing-guide

Conversation

@vinpogo

@vinpogo vinpogo commented Feb 21, 2026

Copy link
Copy Markdown
Owner

Closes #25

Copilot AI review requested due to automatic review settings February 21, 2026 16:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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, clarifies pnpm 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 documenting pnpm oxfmt --check (and optionally pnpm oxfmt to apply fixes) so contributors can match CI locally.
# Lint and format code
pnpm oxlint
pnpm oxlint --fix
pnpm oxfmt

Comment thread CONTRIBUTING.md

> 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/)

Copilot AI Feb 21, 2026

Copy link

Choose a reason for hiding this comment

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

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/)

Copilot uses AI. Check for mistakes.
Comment thread CONTRIBUTING.md
4. Ensure code passes linting: `pnpm run lint`
4. Ensure code passes linting: `pnpm oxlint`
5. Run tests: `pnpm test`
6. [optional] add changeset

Copilot AI Feb 21, 2026

Copy link

Choose a reason for hiding this comment

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

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`

Copilot uses AI. Check for mistakes.
Comment thread CONTRIBUTING.md
@vinpogo
vinpogo merged commit 0c44eb5 into main Feb 21, 2026
4 checks passed
@vinpogo
vinpogo deleted the docs/contributing-guide branch February 21, 2026 16:13
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.

Validate CONTRIBUTING.md

2 participants