Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1.21 KB
Raw

Contributing to CTest Lab

Formatting the Code

Use prettier to format the code. I configured prettier in package.json; you should be able to run it without any special options:

npx prettier --write .

If your IDE has an extension to run prettier, that can help automate it for you. If you use VS Code, I configured esbenp.prettier-vscode as the default formatter.

Testing the User Documentation

If you modify the user documentation, test your changes locally. Follow these steps:

  1. Install Jekyll
  2. Install Ruby Gems: bundle install
  3. Build and serve the documentation: bundle exec jekyll serve
  4. Open the site, http:https://localhost:4000, in your web browser.

You only need to perform step 1 once. You need to perform step 2 each time you clone the repository or update docs/Gemfile. You need to run step 3 anytime you edit *docs/_config.yml; if you edit the Markdown files, Jekyll should automatically update the site, though you need to manually refresh your browser.