Files
pnpm/pnpr/CONTRIBUTING.md
T
Zoltan KochanandClaude Opus 5.5 6f95957063 docs: lint prose with Vale (#17238)
* docs: lint prose with Vale

Add Vale with an in-repo style, .vale/styles/pnpm, that turns the
writing rules in AGENTS.md and the Google developer documentation style
guide into lint rules. The stock Vale packages (Google, Microsoft,
RedHat, write-good) were too noisy to block on, for example 1,300
passive-voice hits in the v12 docs alone, so the rules are written for
this repo, following the GitLab model. Each one links the guideline it
enforces.

Levels:
- error, fails CI: dashes, plain-word substitutions, condescending
  words, "please", "note that", hedges, puffery, optional plurals,
  exclamation marks, ellipses, curly quotes, generic link text, product
  spellings, sentence-case headings, repeated words, double spaces,
  implementation history in comments; in changesets, bold or italic
  emphasis, internal names and release-line names.
- warning: future tense, sentences over 30 words, "instead of" and
  "so that" tails in changesets.
- suggestion: passive voice.

.vale.ini scopes the rules. Docs get every rule. Contributor Markdown
and code comments keep dashes and headings as warnings until their
roughly 8,100 em dashes are rewritten. Released changesets stay in
.changeset/ and are not rewritten, so lint-prose.mjs lints only the
changesets added since PROSE_BASE (the PR base in CI).

The prose workflow installs a pinned, checksum-verified Vale release and
runs `pnpm lint:prose`. The rest of this change rewrites the existing
docs, READMEs, contributor Markdown, and code comments to pass the
error-level rules. Only prose and comment text changed. Renamed
headings keep their anchors.

Spelling stays with cspell, which checks identifiers that Vale does not
see.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs: keep prose lint from flattening meaning

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-22 21:48:09 +02:00

1.7 KiB

Contributing to pnpr

pnpr/ is not MIT-licensed like the rest of this monorepo — it is source-available under the PolyForm Shield License 1.0.0. Contributions to this directory are therefore accepted under different terms than the MIT parts of the repository.

Contribution terms

By submitting a contribution to this directory — a pull request, patch, or any other code, documentation, or material — you agree that:

  1. Inbound license. Your contribution is provided under the same PolyForm Shield License 1.0.0 that governs this directory.

  2. Relicensing grant. You also grant Zoltan Kochan (the licensor) a perpetual, worldwide, non-exclusive, irrevocable, and royalty-free license — including the right to sublicense — to use, reproduce, modify, distribute, and relicense your contribution under any terms, including other source-available, open-source, or proprietary/commercial licenses. This lets the licensor change the license of these components in the future (for example, relaxing to a more permissive source-available license, or offering a separate commercial license) without seeking per-contributor consent.

  3. Right to grant. You represent that each contribution is your original work, or that you otherwise have the right to submit it under these terms, and that submitting it does not violate any other party's rights.

If you do not agree to these terms, do not submit contributions to this directory.

Development

For setup, code style, tests, and workflow, follow AGENTS.md and the pacquet contributing guide at ../pnpm/CONTRIBUTING.md.