Skip to content

Commit 55c9166

Browse files
authored
chore(contributing): Update contributing guide (#4190)
1 parent 32212cd commit 55c9166

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,36 @@ To run the build and tests:
2727
make compile
2828
```
2929

30+
# Format
31+
32+
To format the changed code and make CI happy you can run:
33+
34+
```shell
35+
make format
36+
```
37+
38+
or
39+
40+
```shell
41+
./gradlew spotlessApply
42+
```
43+
44+
# Binary compatibility validation
45+
46+
To prevent breaking ABI changes and exposing things we should not, we make use of https://github.com/Kotlin/binary-compatibility-validator. If your change intended to introduce a new public method/property or modify the existing one you can overwrite the API declarations to make CI happy as follows (overwrites them from scratch):
47+
48+
```shell
49+
make api
50+
```
51+
52+
or
53+
54+
```shell
55+
./gradlew apiDump
56+
```
57+
58+
However, if your change did not intend to modify the public API, consider changing the method/property visibility or removing the change altogether.
59+
3060
# CI
3161

3262
Build and tests are automatically run against branches and pull requests

0 commit comments

Comments
 (0)