docs: CONTRIBUTING.md

This commit is contained in:
liihuu 2024-09-18 23:42:28 +08:00
parent 67c58d3284
commit dee7e2f41d

View File

@ -9,15 +9,15 @@ There are many ways to contribute:
+ If you have good ideas, submit a feature requests + If you have good ideas, submit a feature requests
+ Submit pull requests + Submit pull requests
+ Help write some sample code + Help write some sample code
+ Participate in [discussions](https://github.com/liihuu/KLineChart/discussions) + Participate in [discussions](https://github.com/klinecharts/KLineChart/discussions)
### Report Bugs ### Report Bugs
The template we provide helps you to quickly explain the problem and submit. The template we provide helps you to quickly explain the problem and submit.
Please see the [template](https://github.com/liihuu/KLineChart/issues/new?assignees=&labels=&template=bug_report.yml&title=%5BBug%5D+) Please see the [template](https://github.com/klinecharts/KLineChart/issues/new?assignees=&labels=&template=bug_report.yml&title=%5BBug%5D+)
### Feature Requests ### Feature Requests
The same, we also provide templates, is [here](https://github.com/liihuu/KLineChart/issues/new?assignees=&labels=&template=feature_request.yml&title=%5BFeature%5D+) The same, we also provide templates, is [here](https://github.com/klinecharts/KLineChart/issues/new?assignees=&labels=&template=feature_request.yml&title=%5BFeature%5D+)
### Pull Requests ### Pull Requests
Before submitting pull requests, several goals need to be identified: Before submitting pull requests, several goals need to be identified:
@ -25,6 +25,3 @@ Before submitting pull requests, several goals need to be identified:
+ Make sure your code passes the lint check `npm run lint` + Make sure your code passes the lint check `npm run lint`
+ Do only one thing at a time + Do only one thing at a time
+ The commit log must state the purpose + The commit log must state the purpose
### Sample Code
[KLineChartSample](https://github.com/liihuu/KLineChartSample), This is the sample code project. Submit to the directory of the corresponding framework.