Skip to content

Latest commit

 

History

History
13 lines (7 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

13 lines (7 loc) · 1.64 KB

Contribute

Each package has its own specifications for contribution. Please refer to the CONTRIBUTING.md file in the package you want to contribute to.

Conventional commits

We use conventional commits to automate the release process. Please follow the commit message format described in the link above. Lerna will automatically generate the changelog for each package based on the commit messages since the last version. (see README.md)

markdown lint

We don't use relative links bewteen .md files, NPM handles them differently than github does, and this creates a bug on NPM where the links are broken. On this project you have markdown lint set up. You can download the markdown lint VSCode extension, it will lint your .md files as you write them. There is a custom rule that prevents the use of relative links in .md files. You can check it if you need to write a new custom rule. The scipt and the extension use this configuration file, and the custom rules that are added in the VS Code settings