Thank you for taking the time to read our contribution guidelines. You can start contributing in many ways like filing bug reports, improving documentation, or helping others.
Open source community strives to be nice, welcoming and professional. Instances of abusive, harassing, or otherwise unacceptable behavior will not be tolerated.
- Fork the Conventional Commits repository
- Create a new branch for each feature, fix or improvement
- Send a pull request from each feature branch to the master branch
- Include a good description about what the PR is fixing or adding
- Make sure the available lint tools are not throwing any error before PR merge
- Squash related commits before a PR merge.
- smart-xapi-dsl is written in Typescript.
- We use Prettier and TSLint to format and check our code. You can use
npm run lintbefore submitting a pull request. - Please use Conventional Commits specification
- Before submitting a bug report, search the issues for similar tickets. Your issue may have already been discussed and resolved.
- Feel free to add a comment to an existing issue, even if it's closed.
- Be thorough in your title and report, don't leave out important details.
- English, please.
- Feel free to create a new test file if none of the existing test files suits your test case.
- Help us keeping a good test coverage :D.
- Make use
npm run testreturn a full green report before submitting a pull request.