This project is licensed under the Unlicense. By submitting a pull request to eleventh, you represent that you have the right to license your contributions to eleventh under the project's license, and agree by submitting the patch that your contributions are licensed under the same license as eleventh.
All commits in eleventh follow the Conventional Commits standard. This helps to promote descriptive commit messages and also informs our CI/CD pipeline to automatically bump the package version according to Semantic Versioning and generate the CHANGELOG.md.
Developers should strive for atomic commits which are relatively small in size, narrow in scope, and easy to read. All commits in eleventh must pass the test suite.
Each pull request should be narrow in scope. A pull request might introduce a new feature, fix a defect, or refactor some code, but it should not do more than one of these.
To begin, please fork the project under your own account.
Next, git clone your fork to your local development machine.
Create a new branch for your changes. For example, git checkout -b feature/add-a-widget.
Run npm install to install the development dependencies.
Use your favorite text editor to make changes to the project.
You can run npm test to execute the full test suite, and you can run npm run lint to use ESLint to check for possible errors or formatting issues. Some formatting issues can automatically be fixed by running npm run lint -- --fix.
To make committing easier, we invite you to use the npm run commit command which invokes the Commitizen command line prompt for creating a valid commit message.
Push your branch to GitHub. For example, git push --set-upstream origin feature/add-a-widget.
Create a new pull request. The source branch should be from your own fork of the project, and the target branch should be master of the main project.