CONTRIBUTING.md 875 字节
Newer Older
Z
zengqiao 已提交
1
# Contribution Guideline
Z
init  
zengqiao 已提交
2

Z
zengqiao 已提交
3
Thanks for considering to contribute this project. All issues and pull requests are highly appreciated.
Z
init  
zengqiao 已提交
4

Z
zengqiao 已提交
5
## Pull Requests
Z
init  
zengqiao 已提交
6

Z
zengqiao 已提交
7
Before sending pull request to this project, please read and follow guidelines below.
Z
init  
zengqiao 已提交
8

Z
zengqiao 已提交
9
1. Branch: We only accept pull request on `dev` branch.
Z
zengqiao 已提交
10
2. Coding style: Follow the coding style used in LogiKM.
Z
zengqiao 已提交
11 12
3. Commit message: Use English and be aware of your spell.
4. Test: Make sure to test your code.
Z
init  
zengqiao 已提交
13

Z
zengqiao 已提交
14
Add device mode, API version, related log, screenshots and other related information in your pull request if possible.
Z
init  
zengqiao 已提交
15

Z
zengqiao 已提交
16
NOTE: We assume all your contribution can be licensed under the [AGPL-3.0](LICENSE).
Z
init  
zengqiao 已提交
17

Z
zengqiao 已提交
18
## Issues
Z
init  
zengqiao 已提交
19

Z
zengqiao 已提交
20
We love clearly described issues. :)
Z
init  
zengqiao 已提交
21

Z
zengqiao 已提交
22
Following information can help us to resolve the issue faster.
Z
init  
zengqiao 已提交
23

Z
zengqiao 已提交
24 25 26 27 28
* Device mode and hardware information.
* API version.
* Logs.
* Screenshots.
* Steps to reproduce the issue.