diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c7ba039 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# Contributing guide + +## Pull requests + +- Consider opening an issue before submitting a pull-request to avoid unnecessary work +- Ensure pull request titles adhere to the [Conventional Commits][] specification + +[conventional commits]: https://www.conventionalcommits.org/ + +## Release + +The module is released automatically from the `main` branch using [semantic-release-action][]. Version bumps and change logs are generated from the commit messages. + +[semantic-release-action]: https://github.com/cycjimmy/semantic-release-action + +## Development setup + +After cloning the repository, use the `setup` script to install development dependencies and the `validate` script to run all checks and tests to verify your setup. + +```shell +npm run setup +npm run validate +``` + +### Lint and format + +Run auto-formatting to ensure any changes adhere to the code style of the repository: + +```shell +npm run format +``` + +To run lint and format checks without making any changes: + +```shell +npm run lint +``` + +### Test + +Run unit tests once or in watch mode: + +```shell +npm test +npm run test:watch +``` + +### Docs + +Use the `toc` script to ensure the README's table of contents is up to date: + +```shell +npm run toc +``` + +Use `contributors:add` to add a contributor to the README: + +```shell +npm run contributors:add +``` + +Use `contributors:generate` to ensure the README's contributor list is up to date: + +```shell +npm run contributors:generate +``` diff --git a/README.md b/README.md index 0808979..bb0906c 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,6 @@ - - [The Problem](#the-problem) - [This Solution](#this-solution) - [Installation](#installation) @@ -119,23 +118,25 @@ Thanks goes to these people ([emoji key][emojis]):
Ben Monro 💻 ⚠️ 🤔 📖 |
- Emil Tholin 💻 ⚠️ 🤔 |
- Eduardo Rabelo ⚠️ 💻 📖 💡 |
- Tim Deschryver 📖 |
- Emanuele 💻 ⚠️ 📖 |
- pngwn 💻 ⚠️ |
- Sebastian Silbermann 💻 |
-
Rahim Alwer 💻 📖 ⚠️ 👀 |
- Bob 🐛 💻 |
- Ron Merkin 💻 |
- Ben McCann ⚠️ |
- John Bowser 💻 ⚠️ |
- Yoann 💻 |
- |
Ben Monro 💻 ⚠️ 🤔 📖 |
+ Emil Tholin 💻 ⚠️ 🤔 |
+ Eduardo Rabelo ⚠️ 💻 📖 💡 |
+ Tim Deschryver 📖 |
+ Emanuele 💻 ⚠️ 📖 |
+ pngwn 💻 ⚠️ |
+ Sebastian Silbermann 💻 |
+
Rahim Alwer 💻 📖 ⚠️ 👀 |
+ Bob 🐛 💻 |
+ Ron Merkin 💻 |
+ Ben McCann ⚠️ |
+ John Bowser 💻 ⚠️ |
+ Yoann 💻 |
+