Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 1.3 KB

Contributing

To make changes to the documentation complete the following steps.

  1. Fork the source repository.
  2. Create a branch in your fork.
  3. Make your Changes.
  4. Verify the changes.
  5. Commit and push your changes to your branch.
  6. Create a PR to the source repository.
  7. Verify all the checks are passing.
  8. Complete any applicable tasks.
  9. Make sure to keep your branch up-to-date.

Note

This CONTRIBUTING guide is a work in progress.
To suggest a change please open a PR or an Issue.

Changes

While modifying the docs you can view a live preview with hot reloading.

npm install
npm run dev

Verify

Before pushing your changes, verify the build completes without error.

npm run build

You can then preview the live build to ensure it appears as expected.

npm run preview

Lastly, make sure everything is formatted with Prettier.

npm run prettier

Otherwise, format them manually.

npx prettier --write .

For more details on checks see: .github/workflows/lint.yaml