We want to make contributing to our project as easy and transparent as possible.
We use All Contributors specification to handle recognitions.
Our repositories follow Conventional Commits specification. Releasing to GitHub and NPM is done with the support of semantic-release.
Pull requests should have a title that follows the specification, otherwise, merging is blocked. If you are not familiar with the specification simply ask maintainers to modify. You can also use this cheatsheet if you want:
fix:prefix in the title indicates that PR is a bug fix and PATCH release must be triggered.feat:prefix in the title indicates that PR is a feature and MINOR release must be triggered.docs:prefix in the title indicates that PR is only related to the documentation and there is no need to trigger release.chore:prefix in the title indicates that PR is only related to cleanup in the project and there is no need to trigger release.test:prefix in the title indicates that PR is only related to tests and there is no need to trigger release.refactor:prefix in the title indicates that PR is only related to refactoring and there is no need to trigger release.
What about MAJOR release? just add ! to the prefix, like fix!: or refactor!:
Prefix that follows specification is not enough though. Remember that the title must be clear and descriptive with usage of imperative mood.
Happy contributing ❤️
Feel free to contact the maintainers if that's a concern.
This document was adapted from the open-source contribution guidelines for AsyncApi Initiative.