We want to make contributing to this project as easy and transparent as possible. Hopefully this document makes the process for contributing clear and answers any questions you may have. If not, feel free to open an Issue.
All active development of Spec Markdown happens on GitHub. We actively welcome your pull requests.
- Fork the repo and create your
branch from
main. - Install all dependencies. (
npm install) - If you've added code, add tests.
- If you've changed APIs, update the documentation.
- Run tests and ensure your code passes lint. (
npm test)
We will do our best to keep main in good shape, with tests passing at all
times. But in order to move fast, we might make API changes that your
application might not be compatible with. We will do our best to communicate
these changes and always version appropriately so you can
lock into a specific version if need be. If any of this is worrysome to you,
just use npm.
We use GitHub issues to track public bugs and requests. Please ensure your bug description is clear and has sufficient instructions to be able to reproduce the issue. The best way is to provide a reduced test case on jsFiddle or jsBin.
- 2 spaces for indentation (no tabs)
- 80 character line length strongly preferred.
- Prefer
'over" - Use semicolons;
- Trailing commas,
- Avd abbr wrds.
By contributing to Spec Markdown, you agree that your contributions will be licensed under its MIT license.