apfree_wifidog/CONTRIBUTING.md

47 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2017-03-23 16:39:32 +08:00
Contributing
================================================================================
If you want to contribute to [apfree wifidog](https://github.com/liudf0716/apfree_wifidog), please follow these simple rules:
1. Press the fork button:
2. Clone the repository from your account with:
```
2023-01-07 11:13:08 +08:00
git clone https://github.com/your_github_username/apfree_wifidog.git
2017-03-23 16:39:32 +08:00
```
3. Create a new branch with:
```
2023-01-07 11:13:08 +08:00
cd apfree_wifidog
2017-03-23 16:39:32 +08:00
git checkout -b "apfree_wifidog-1-fix"
```
You can name it however you want.
2023-01-07 11:13:08 +08:00
4. Make your changes and test the feature you added or bug you fixed
2017-03-23 16:41:31 +08:00
2017-03-23 16:46:39 +08:00
5. Don't forget to add yourself in `contributors.md`.
6. Commit and push your changes, then make a pull request from Github.
2018-12-18 14:31:49 +08:00
```
2023-01-07 11:13:08 +08:00
git add file_you_changed
git commit -s
2018-12-18 14:31:49 +08:00
git push origin apfree_wifidog-1-fix
```
2017-03-23 16:46:39 +08:00
7. Awaiting review, if accepted, merged!
2017-03-23 16:39:32 +08:00
**IMPORTANT**
2017-05-19 15:46:58 +08:00
Please, **don't forget to update your fork**. While you made your changes, the content of the `master` branch can change because other pull requests were merged and it can create conflicts. This is why you have to rebase on `master` every time before pushing your changes and check that your branch doesn't have any conflicts with `master`.
2017-03-23 16:39:32 +08:00
Thank you.
2017-10-24 15:02:24 +08:00
中文参考
https://www.zhihu.com/question/21682976