Skip to content

Commit c5424f5

Browse files
committed
📝 add CONTRIBUTING.md
1 parent a81d192 commit c5424f5

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

CONTRIBUTING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing
2+
We'd love for you to contribute to our source code and to make the project even better than it is today!
3+
Here are the guidelines we'd like you to follow:
4+
5+
- [Code of Conduct](#coc)
6+
- [Git Commit Messages](#commit)
7+
- [Got a Question or Problem?](#question)
8+
- [Found an Issue?](#issue)
9+
10+
## <a name="coc"></a> Code of Conduct
11+
[Code of Conduct](https://github.com/hyper-designed/hyper_effects/blob/main/CODE_OF_CONDUCT.md)
12+
13+
## <a name="commit"></a> Git Commit Messages
14+
15+
* Use the present tense ("Add feature" not "Added feature")
16+
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
17+
* Limit the first line to 72 characters or less
18+
* Reference issues and pull requests liberally after the first line
19+
* When only changing documentation, include `[ci skip]` in the commit title
20+
* Consider starting the commit message with an applicable emoji:
21+
* :art: `:art:` when improving the format/structure of the code
22+
* :racehorse: `:racehorse:` when improving performance
23+
* :non-potable_water: `:non-potable_water:` when plugging memory leaks
24+
* :memo: `:memo:` when writing docs
25+
* :bug: `:bug:` when fixing a bug
26+
* :fire: `:fire:` when removing code or files
27+
* :green_heart: `:green_heart:` when fixing the CI build
28+
* :white_check_mark: `:white_check_mark:` when adding tests
29+
* :lock: `:lock:` when dealing with security
30+
* :arrow_up: `:arrow_up:` when upgrading dependencies
31+
* :arrow_down: `:arrow_down:` when downgrading dependencies
32+
* :shirt: `:shirt:` when removing lint/checkstyle warnings
33+
34+
Find all the available emojis [here](https://gitmoji.carloscuesta.me/).
35+
36+
## <a name="question"></a> Got a Question or Problem?
37+
38+
If you feel that we're missing an important bit of documentation, feel free to
39+
file an issue so we can help. Here's an example to get you started:
40+
41+
```
42+
What are you trying to do or find out more about?
43+
44+
Where have you looked?
45+
46+
Where did you expect to find this information?
47+
```
48+
49+
## <a name="issue"></a> Found an Issue?
50+
If you find a bug in the source code or a mistake in the documentation, you can help us by
51+
submitting an issue to our project.
52+
53+
To submit an issue, please check the [Issue Template](https://github.com/hyper-designed/hyper_effects/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
54+
55+
Even better you can submit a Pull Request with a fix.
56+
57+
### Pull Request
58+
To generate a pull request, please consider following [Pull Request Template](https://github.com/hyper-designed/hyper_effects/blob/main/PULL_REQUEST_TEMPLATE.md).
59+
60+
* Search [GitHub](https://github.com/hyper-designed/hyper_effects/pulls) for an open or closed Pull Request
61+
that relates to your submission. You don't want to duplicate effort.
62+
* Please have a look at [License](https://github.com/hyper-designed/hyper_effects/blob/main/LICENSE) before sending pull
63+
requests. We cannot accept code without this.
64+
65+
That's it! Thank you for your contribution!

0 commit comments

Comments
 (0)