docs: update README.md

This commit is contained in:
muwoo 2021-09-22 18:04:55 +08:00
parent 7a1777e083
commit 6864836399
2 changed files with 50 additions and 1 deletions

46
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,46 @@
# Contributing to Rubick
## Set up
Install dev deps after git clone the repo.
```bash
$ npm install
$ npm run rebuild
$ npm run dev
```
## Build
Transform with babel and webpack.
```bash
# macos
$ npm run build
# other system
$ npm run build_win
```
## Docs
```bash
# add doc
$ cd docs
$ npm i
$ npm run docs:dev
```
## Pull requests
**Working on your first Pull Request?** You can learn how from this *free* series
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
All pull requests are welcome. Thanks for taking the time to contribute.
- Create an issue about the features, such as new components.
- Fork the repo to your own account.
- Clone your fork.
- Create a new branch base on `dev`, if you want to add new component, the branch name should be formatted as `component-[Component Name]`. (e.g. `component-steps`) And the commit info should be formatted as `[Component Name]: Info about commit`.
- Make sure that running `npm run build_win` outputs the correct files.
- Rebase before creating a PR to keep commit history clear. (Merge request to branch `dev`)
- Provide some description about your PR.

View File

@ -89,7 +89,10 @@ Based on `robot.js` and `iohook`。
<img src=https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/62cc424eacac4c9eb178f0e055e87d9a~tplv-k3u1fbpfcp-watermark.image width=500 />
### At last
## Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. <a href="https://github.com/clouDr-f2e/rubick/graphs/contributors"><img src="https://opencollective.com/rubick/contributors.svg?width=890&button=false" /></a>
## Feedback
对本项目有兴趣或者想要交流学习的同学可以扫码加下面的微信,备注 rubick帮助我们更好的成长
![image](https://user-images.githubusercontent.com/21073039/127327603-9796f246-ee4b-4950-a69d-ce3205ec9569.png)