Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (21 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.07 KB

Contributing

We are super happy if you are interested in contributing to the documentation of the Green Metrics Tool.

All contributions should be done via Pull Requests. We use the standard forking workflow for Pull Requests. If you are not familiar with forks, you can find more information e.g. in GitHub's documentation

Lint

We use markdownlint-cli2 for linting the content of the documentation.

To check if the content has linting issues you can call

npm run lint:markdown

in the project directory.

To automatically resolve fixable issues, use

npm run lint:markdown-fix

We recommend that you set a pre-commit hook to lint and fix issues automatically every time you commit. This can be done by adding

npm run lint:markdown-fix:staged
# or, if you want to fix manually
npm run lint:markdown:staged

to a file named ./.git/hooks/pre-commit and making it executable chmod +x ./.git/hooks/pre-commit