Skip to content
This repository was archived by the owner on Apr 23, 2026. It is now read-only.

Commit 2baea0a

Browse files
authored
docs: add contributors file
1 parent ecc63cd commit 2baea0a

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing 👫
2+
3+
## Following our standards with git hooks 🌲
4+
5+
In this repository, we're following some git conventions that all commits should follow:
6+
7+
* We're following
8+
the [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and all the pull requests
9+
that we merge should be in that format.
10+
11+
## Issues 🚩
12+
13+
Issues are very valuable to this project.
14+
15+
- Ideas are a valuable source of contributions others can make
16+
- Problems show where this project is lacking
17+
- With a question you show where contributors can improve the user
18+
experience
19+
20+
Thank you for creating them.
21+
22+
## Pull Requests ❤️
23+
24+
Pull requests are, a great way to get your ideas into this repository.
25+
26+
When deciding if I merge in a pull request I look at the following
27+
things:
28+
29+
### Does it state intent
30+
31+
You should be clear which problem you're trying to solve with your
32+
contribution.
33+
34+
For example:
35+
36+
> feat(login): change loggin button
37+
38+
Doesn't tell me anything about why you're doing that
39+
40+
> feat(login): change loggin buttons because the current colors
41+
> make a contrast that isn't easy to read.
42+
43+
Tells me the problem that you have found, and the pull request shows me
44+
the action you have taken to solve it.
45+
46+
### Is it of good quality
47+
48+
- There are no spelling mistakes
49+
- It reads well
50+
- For english language contributions: Has a good score on
51+
[Grammarly](https://www.grammarly.com) or [Hemingway
52+
App](https://www.hemingwayapp.com/)

0 commit comments

Comments
 (0)