Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (18 loc) · 876 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 876 Bytes

Contributing to opentdf/docs

Thank you for contributing to OpenTDF documentation! For general contribution guidelines, community feedback channels, and branch/commit conventions, see platform/CONTRIBUTING.md.

The information below is specific to documentation contributions.

Prerequisites

Check spelling and grammar for your changes

Install the required vale packages:

vale sync

Run vale on changed files:

git diff --name-only | xargs vale --glob='!blog/*'

Verify changes on the Docusaurus server

To verify the placement and style of your changes as well as ensure there are no breaking changes, follow the instructions in the README for running the Docusaurus server locally.