apfree_wifidog/CONTRIBUTING.md
2023-01-07 11:13:08 +08:00

47 lines
1.3 KiB
Markdown

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:
```
git clone https://github.com/your_github_username/apfree_wifidog.git
```
3. Create a new branch with:
```
cd apfree_wifidog
git checkout -b "apfree_wifidog-1-fix"
```
You can name it however you want.
4. Make your changes and test the feature you added or bug you fixed
5. Don't forget to add yourself in `contributors.md`.
6. Commit and push your changes, then make a pull request from Github.
```
git add file_you_changed
git commit -s
git push origin apfree_wifidog-1-fix
```
7. Awaiting review, if accepted, merged!
**IMPORTANT**
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`.
Thank you.
中文参考
https://www.zhihu.com/question/21682976