-
Notifications
You must be signed in to change notification settings - Fork 15
/
CONTRIBUTING.md
51 lines (32 loc) · 2.21 KB
/
CONTRIBUTING.md
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
You made it here! This is a great step in helping to contribute to ARK Navigator 🎈
## How to contribute
To get started, you can start off here [issues](https://github.com/ARK-Builders/ARK-Navigator/issues) with those tagged `good first issue`.
You can find fresh builds as artifacts of [GitHub Actions workflows](https://github.com/ARK-Builders/ARK-Navigator/actions):
* The most recent stable APK file is produced from `main` branch
* Every workflow must have both _Release_ and _Debug_ build
## Forking the project
Before we can add you as a contributor to our project, we suggest to do initial work from your own fork of the project.
To create a fork, please press `fork` button on the project page:
Then you can modify everything without fear of breaking official version.
## Submitting a Pull Request
After you've implemented a feature or fixed a bug, it is time to open Pull Request.
Please enable GitHub Actions in your fork, so our QA will be able to download build of your version without manually compiling from source code.
### Automated code style checks
The projects embeds `ktlint` in order to enforce consistent code style.
Before a PR can be merged, you would have to fix all code style errors.
### Code review
We care a lot about our software quality, that's why we are conducting strict code reviews before merging:
* we will ask questions if we are not sure about particular technical decision
* when possible, we will suggest alternative solution
* GitHub Actions workflow must result in success (be green)
* comments must be resolved before merge
* code style should be green as well
Right now, the team isn't that big, so please be patient 🙂
### Merge conflicts
If Pull Request is long time in reviewing phase, `main` branch might go forward too far.
Please, fix all merge conflicts in this case 🛠
## Additional read
https://docs.github.com/en/get-started/quickstart/github-flow