Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.67 KB
Raw

Contributing

Thank you for taking the time to contribute! Guidelines below are meant to help you along the way. All contributions are welcome, including ideas, tweaks and more.

Code of Conduct

This project is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

Proposing a change

Before making a non-trivial change, please discuss it via issues.

Development process

Please keep the scope of each pull request to one specific feature or fix.

Prequisites

Workflow

  1. Assign related issues to yourself

  2. Clone a fork of the main branch and install all the required dependencies with npm install

  3. Make changes to the codebase

  4. Before pushing, fix any errors possibly emitted by the following commands:

    • npm run format fixes stylistic issues using Prettier
    • npm run lint enforces coding rules based on the Airbnb JavaScript Style Guide
    • npm run type-check checks for errors in TypeScript code

  5. Record your changes with npm run commit, adhering to the Conventional Commits specification

  6. Open a new pull request, referencing corresponding issues if available

License

As a collaborator, you agree to license your contributions under the project's MIT license.