Skip to content

Latest commit

 

History

History
80 lines (61 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

80 lines (61 loc) · 3.38 KB
Raw

Contributing to Strapi Plugin Field Formula

Thank you for taking an interest in contributing! We appreciate you! 🫶🏽

Below are the guidelines on how to help in the best possible way.

Submitting an Issue

Before creating a new issue, please search through open issues using the GitHub issue search bar. You might find the solution to your problem, or can verify that it is an already known issue.

We want a bug-free and best-performing project. That's why we take all reported issues to heart. But please be aware that if we can't reproduce the problem, we won't have a way of locating and adequately fixing it.

Therefore, to solve the problem in the best possible way, please create a minimal repository that reproduces the problem with the least possible code explaining and demonstrating the error.

Without enough information to reproduce the issue, we will close it because we can't recreate and solve it.

Make sure the appropriate labels are added Read more information about issue and pull request labels

Submitting a Pull Request (PR)

Branch Organization

We adopt trunk-based development therefore all Pull Requests are made against the main branch because we do not use separate branches for development or for the versions we release.

Good first issue

The issues marked with ~"good first issue" label are a good starting point to familiarize yourself with the project.

Before solving the problem, please check with the maintainers that the issue is still relevant. Feel free to leave a comment on the issue to show your intention to work on it and prevent other people from unintentionally duplicating your effort.

Sending a Pull Request

Before submitting a pull request, consider MR checklist is fully resolved. You could find it in the PR template. For more information you could read the CODE_REVIEW document.

Local development

Clone repository:

git clone [email protected]:BorysShulyak/strapi-plugin-field-formula.git

If you want to open a PRs you could fork the repository. For more information read the following docs: Fork a repo, Contributing to projects.

The list of commands

Install dependencies:

yarn

Run linters:

yarn run lint

Run linters with autofix:

yarn run lint-fix

Run tests:

yarn run test

Run commit:

yarn run commit

Conventional commits

We are using the conventional commits in this repo. To automate this process we have integrated the commitlint to check if your commit messages meet the conventional commit format.

Running the commit command would ask you a few questions to generate the commit message following the next rules of @commitlint/config-conventional. Read more..