Skip to content

docs: add pre-PR validation checklist to CONTRIBUTING [guide] #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
hivecommons-hive wants to merge 1 commit into from
Closed

docs: add pre-PR validation checklist to CONTRIBUTING [guide] #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,20 @@ Thank you for helping improve the Hive Commons documentation site
- Site code, navigation, and layout changes belong in this repository.
- Sign your commits with the DCO: `git commit -s`.
- Open an issue at https://github.com/hivecommons/docs/issues for anything unclear.

## Before you open a PR

CI runs these checks on every PR; run them locally first so you catch
failures before pushing:

```bash
npm run lint:md # markdownlint-cli2 on README, CONTRIBUTING, and docs content
npm run type-check # tsc --noEmit
npm test # vitest run
npm run check-links # validates internal doc links
npm run lint # eslint on src/
```

`npm run build` also exercises the doc-sync scripts (`sync-hive-docs`,
`sync-sibling-docs`) and is worth running if you changed anything under
`scripts/`.
Loading