🙌 Thanks for your interest in contributing to Elastic Charts! 🙌
We are trying to enforce some good practices in this library:
- All commits must follow the conventional commits
- semantic-release is used as an automated release manager suite.
This will automatically publish on NPM on every push on master, will automatically create the changelog and bump the correct semver depending on the commits. To avoid too many new releases, especially in this initial phase of the project, we are going to work against a
devbranch and then merge on master periodically. - Every commit count in the version bump: this means that we can merge a PR with two methods:
- merge all the PR commit history (please follow the commit convention or squash partial commits)
- squash and merge all commits using a single commit that follows the conventions.
The following tools are used to ensure this convention:
commitlinthook ensure that you are following correctly the convention,yarn czcan be used to startcommitizenas a cli tool that prompts you with selections and questions to help you in writing a conventional commit.