apfree_wifidog/CONTRIBUTING.md

41 lines
1.1 KiB
Markdown
Raw 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:
![fork](http://oi58.tinypic.com/jj2trm.jpg)
2. Clone the repository from your account with:
```
git clone git@github.com:your_github_username/apfree_wifidog.git
```
3. Create a new branch with:
```
git checkout -b "apfree_wifidog-1-fix"
```
You can name it however you want.
2017-03-23 16:41:31 +08:00
4. Make your changes
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.
2017-03-23 16:41:31 +08:00
git commit --signoff
git push -f
2017-03-23 16:46:39 +08:00
7. Awaiting review, if accepted, merged!
2017-03-23 16:39:32 +08:00
**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.