-
Notifications
You must be signed in to change notification settings - Fork 18
/
CONTRIBUTING
31 lines (20 loc) · 1.66 KB
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# CONTRIBUTION GUIDE
[1. Branch Organisation](https://github.com/EmmanuelOmoiya/CRUL/blob/master/CONTRIBUTING.md#branch-organization) |
[2. Prerequisites](https://github.com/EmmanuelOmoiya/CRUL/blob/master/CONTRIBUTING.md#prerequisites) |
[3. Report Bugs](https://github.com/EmmanuelOmoiya/CRUL/blob/master/CONTRIBUTING.md#how-to-report-bugs) |
[4. Non-Coding Contribution](https://github.com/EmmanuelOmoiya/CRUL/blob/master/CONTRIBUTING.md#non-coding-contribution)
### Branch Organization
Submit all changes directly to the main branch. We don’t use separate branches for development or for upcoming releases. We do our best to keep main in good shape, with all tests passing.
Code that lands in the main must be compatible with the latest stable release. It may contain additional features, but no breaking changes. We should be able to release a new minor version from the tip of the main at any time.
### Prerequisites
- You have Node installed at least v12.0.0+ and Yarn at v1.2.0+.
- You are familiar with Git.
### How to Report Bugs
In order to report bugs, you should create an issue and describe the bug properly and you can also suggest a way to fix it (in case you know it). You should mention your device details (if possible) so that we can find the fix fast.
### Non-Coding Contribution
Your Contribution is Valuable to us and there are various ways to contribute to this project if are not from a coding background, like:
- You can help us to improve our Design
- You can create a Documentation for this project
- You can help us in the Marketing department.
- You can even edit this file. <br>
basically, if you want to contribute then there are infinite ways to contribute