Rainbond/CONTRIBUTING.md
2020-09-07 09:40:11 +08:00

37 lines
830 B
Markdown

# Compile the project
```
# you must have docker and golang environment
# build all docker image
make image
# build all binary file
make binary
# build binary for different os
GOOS=windows make binary
# if you what build one component
make binary WHAT=api
make image WHAT=api
```
# How to contribute
Read [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/) before contribute.
## Bug
When you find a bug, or have questions about code, documents and project, use **ISSUE** to report and discuss.
## Feature
If you are able to fix bugs or add feature for Rainbond, your **Pull Request** are welcome!
Check Pull Request is another way to contribute.
## Documents
When you find any typo or you have awesome contents to supplement, you can also use **Pull Request**.