Skip to content

Commit c5236e1

Browse files
Piotr PiskorskiPiotr Piskorski
authored andcommitted
Add PR and CodeStyle rules to CONTRIBUTING.md
1 parent 4f9bb3d commit c5236e1

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,18 @@
1-
# Documentation
1+
# Contributing
2+
3+
## Creating new Pull Request
4+
* Fork repository and work on your fork.
5+
* Create a new PR with a request to merge to the **main** branch
6+
* If PR is based on issue, then include its number in PR title and add link to it in description
7+
* One pull request should always address one issue or feature
8+
* When contributing a new feature, provide motivation and use-cases describing value it may brings to the project
9+
* Adding video or screenshot is very beneficial, but it's not mandatory
10+
* Make sure any code contributed is covered by test and documented
11+
12+
## Code Style
13+
* Make sure your code is meeting the default [Ktlint standards](https://ktlint.github.io/#rules)
14+
15+
## Documentation
216
Dokka is added to the project, so to create (or, better say, update) the docs, you need to run
317
```
418
./gradlew charts:dokkaHtml
@@ -10,7 +24,7 @@ After the task is done, copy the generated docs into `./docs`, which can also be
1024
rm -rf ./docs ; cp -r ./charts/build/dokka/html ./docs
1125
```
1226

13-
# Testing
27+
## Testing
1428
Testing is implemented using [Shot](https://github.com/pedrovgs/Shot) library. In order to run
1529
it against prerecorded results, create at least one of the following emulators:
1630
- tablet: Nexus 10, running API 31
@@ -28,7 +42,7 @@ where `$deviceName` is one of:
2842
- Nexus_10_API_31
2943
- Pixel_4a_API_31
3044

31-
## Flakiness
45+
### Flakiness
3246
Due to differences in graphics between M1 and x86 chips, images appear different to the script
3347
and so the tests fail (difference between images can be well above 10%). To human eye they do
3448
seem the same, though. This is explained and shown in [issue 265](https://github.com/pedrovgs/Shot/issues/265). Until this is fixed, there is a way to test stuff at least locally:
@@ -41,7 +55,7 @@ seem the same, though. This is explained and shown in [issue 265](https://github
4155
5. comment the flaky tests out again
4256
6. revert the screenshots
4357

44-
## Other issues
58+
### Other issues
4559

4660
- Library [does not work with Java 17](https://github.com/pedrovgs/Shot/pull/292). The error
4761
itself is not as obvious as one might expect, though. To fix the issue, use Java 11.

0 commit comments

Comments
 (0)