Skip to content

Commit 966c382

Browse files
committed
Add contributing and building section
1 parent 92a2254 commit 966c382

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,55 @@ VerticalGrid(
5656

5757
For more information, please visit [documentation](https://cheonjaeung.github.io/gridlayout-compose/) site.
5858

59+
## Building
60+
61+
This project is kotlin multiplatform project.
62+
It's recommended to setup kotlin multiplatform developement environment.
63+
64+
### Samples
65+
66+
This project contains sample app project in the `samples` directory.
67+
You can run sample app both Andorid and iOS (iOS sample app can run only on the macOS).
68+
69+
### Testing
70+
71+
This project uses snapshot testing.
72+
To run test, run following command:
73+
74+
```shell
75+
./gradlew :grid:verifyPaparazziDebug
76+
```
77+
78+
If you add test cases, run following command to create new snapshots:
79+
80+
```shell
81+
./gradlew :grid:recordPaparazziDebug
82+
```
83+
84+
If test is failed, you can check what is wrong from diff images.
85+
The diff images are generated in `grid/build/paparazzi/failures/` with `delta-*` name.
86+
87+
### Binary Compatibility
88+
89+
This project runs public binary API compatibility validation on CI.
90+
If you change public APIs, run following command before commit:
91+
92+
```shell
93+
./gradlew apiDump
94+
```
95+
96+
And you should commit api files with your code changes.
97+
98+
## Contributing
99+
100+
Welcome to contribute to this project!
101+
Feel free to create pull requests or issues.
102+
103+
- **Patching**: If you want to change code, make a pull request.
104+
- **Bug Reporting**: If you think something is wrong, make an issue and add the **bug** label.
105+
- **Feature Requesting**: If you want to request some features, make an issue and add the **enhancement** label.
106+
- **Questions**: If you have some questions, make an issue and add the **question** label.
107+
59108
## Changelog
60109

61110
Please see [changelog](./CHANGELOG.md) file.

0 commit comments

Comments
 (0)