docs: update contributing guide

Redocly / redocly-cli

⚒️ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.

https://redocly.com/docs/cli/

MIT License

912 stars 139 forks source link

docs: update contributing guide #1494

Closed tatomyr closed 6 months ago

tatomyr commented 6 months ago

What/Why/How?

Updated our contirbuting guide to clarify local, unit, and e2e testing process.

Reference

Testing

Screenshots (optional)

Check yourself

[ ] Code changed? - Tested with redoc/reference-docs/workflows (internal)
[ ] All new/updated code is covered with tests
[ ] New package installed? - Tested in different environments (browser/node)

Security

[x] Security impact of change has been considered
[x] Code follows company security practices and guidelines

changeset-bot[bot] commented 6 months ago

⚠️ No Changeset found

Latest commit: bc594685d0714f310280ae1461d380cf7102de8e

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[bot] commented 6 months ago

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`redocly lint packages/core/src/benchmark/benches/rebilly.yaml`	983.0 ± 15.6	961.6	1008.7	1.00
`redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml`	991.5 ± 21.7	956.8	1023.0	1.01 ± 0.03

github-actions[bot] commented 6 months ago

Coverage report

St.^{:grey_question:}	Category	Percentage	Covered / Total
🟡	Statements	76.67%	4390/5726
🟡	Branches	66.99%	2358/3520
🟡	Functions	70.17%	722/1029
🟡	Lines	76.84%	4121/5363

Test suite run success

716 tests passing in 101 suites.

Report generated by 🧪jest coverage report action from bc594685d0714f310280ae1461d380cf7102de8e