Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

47 lines (34 loc) · 2.83 KB
Raw

Contributing Guidelines

This document contains information and guidelines about contributing to this project. Please read it before you start participating.

See also: Contributor Covenant Code of Conduct

Submitting Pull Requests

You can contribute by fixing bugs or adding new features, you can go through out GitHub issues to start contributing. For larger code changes, we first recommend discussing them in our GitHub dicussions. When submitting a pull request, please do the followings:

  1. Apply standard formatting with npm run format, and verify added code with lint rules by npm run lint.
  2. Add relevant tests and ensure your changes don't break any existing tests (see Automated Tests below).
  3. Run npm run build && npm run package to generate dist/index.js with your changes that will be used as part to E2E tests.
  4. Commit changes according to Conventional Commits standard.

Tip

npm run all can be executed to apply formatting, linting, generate dist/index.js file and run unit tests.

Things you will need

Automated Tests

GitHub action is already setup to run tests on pull requests targeting main branch. However, npm run build && npm run package needs to be used to generate dist/index.js with your changes and these changes needs to be committed along with other code changes.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  1. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
  2. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
  3. The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
  4. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.