Skip to content

Commit 28db91c

Browse files
committed
chore: add CONTRIBUTING.md
1 parent 193fb73 commit 28db91c

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing to the api-clients-automation repository
2+
3+
Welcome to the contributing guide for the api-clients-automation repository!
4+
5+
You can find a lot more information about how to contribute [on our documentation](https://api-clients-automation.netlify.app/docs/contributing/introduction/)
6+
7+
If this guide does not contain what you are looking for and thus prevents you from contributing, don't hesitate to [open an issue](https://github.com/algolia/api-clients-automation/issues/new/choose).
8+
9+
## Reporting an issue
10+
11+
Opening an issue is very effective way to contribute because many users might also be impacted. We'll make sure to fix it quickly if it's technically feasible and doesn't have important side effects for other users.
12+
13+
Before reporting an issue, first check that there is not an already open issue for the same topic using the [issues page](https://github.com/algolia/api-clients-automation/issues). Don't hesitate to thumb up an issue that corresponds to the problem you have.
14+
15+
Another element that will help us go faster at solving the issue is to provide a reproducible test case.
16+
17+
## Code contribution
18+
19+
For any code contribution, you need to:
20+
21+
- Fork and clone the project
22+
- Create a new branch for what you want to solve (fix/_issue-number_, feat/_name-of-the-feature_)
23+
- Make your changes
24+
- Open a pull request
25+
26+
Then:
27+
28+
- A team member will review the pull request
29+
- Automatic checks will run
30+
31+
When every check is green and a team member approves, your contribution is merged! 🚀
32+
33+
## Commit conventions
34+
35+
This project follows the [conventional changelog](https://conventionalcommits.org/) approach. This means that all commit messages should be formatted using the following scheme:
36+
37+
```
38+
type(scope): description
39+
```
40+
41+
In most cases, we use the following types:
42+
43+
- `fix`: for any resolution of an issue (identified or not)
44+
- `feat`: for any new feature
45+
- `refactor`: for any code change that neither adds a feature nor fixes an issue
46+
- `docs`: for any documentation change or addition
47+
- `chore`: for anything that is not related to the library itself (doc, tooling)
48+
49+
Finally, if your work is based on an issue on GitHub, please add in the body of the commit message "fix #1234" if it solves the issue #1234 (read "[Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords)").
50+
51+
Some examples of valid commit messages (used as first lines):
52+
53+
> - fix(javascript): ensure property X is valid
54+
> - chore(deps): update dependency Y to v1.2.3
55+
> - fix(specs): add missing property
56+
> - docs(contributing): reword release section
57+
58+
## Requirements
59+
60+
To run this project, you will need:
61+
62+
- Node.js ≥ 16 – [nvm](https://github.com/creationix/nvm#install-script) is recommended
63+
- [Yarn](https://yarnpkg.com)
64+
- [Docker](https://docs.docker.com/desktop/install/mac-install/)

0 commit comments

Comments
 (0)