Skip to content

Latest commit

 

History

History
61 lines (50 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

61 lines (50 loc) · 3.07 KB

Contributing

First of all, thank you for taking the time to contribute to the project! 👍

How can I help?

Workflow

  1. Fork the repository
  2. Make your changes
    • Make sure that commits follow the Conventional Commits specification

      All this helps with the changelog formation and keeps the history of the project clean

      It would also be useful to indicate in each commit (preferably in the body) the ID of the task in the format `#{ID}' (so that there is linking)

    • Make sure that all checks pass

      $ npm run test
      # > Linting is not broken
      # > The build does not crash
    • To modify/add markdown tables, it is recommended to use ready-made services (for example this)

  3. Open your pull-request from your forked branch and specify related issues (if any)
    • Before creating a PR do at least one self-review of your changes, to save the reviewers' time

    • Also make sure that you describe the problem being solved as clearly as possible (take care of the reviewer) in your PR

      The more details you provide in the description, the better

      You can get acquainted with what pull-requests were made before you

    • If everything is fine, you can ping someone from the core maintainers to speed things up

      If you have any problems, you can temporarily convert your PR into a draft (see the panel on the right)

      Or mark the PR title with the prefix 'WIP:`

    • Make sure that the verification via CI has passed for your PR

      Our common goal is to reduce review costs and achieve consistency in the code base 🤙