From a36536d127b4a71f23f54059a68d8f40ed51af5e Mon Sep 17 00:00:00 2001 From: Dengfeng Liu Date: Thu, 29 Jun 2017 16:33:34 +0800 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c9f3aea --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +Contributing +================================================================================ + +If you want to contribute to [xfrps](https://github.com/kuntengrom/xfrps), 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/xfrps.git + ``` + +3. Create a new branch with: + + ``` + git checkout -b "xfrps-1-fix" + ``` + You can name it however you want. + +4. Make your changes + +5. Don't forget to add yourself in `contributors.md`. + +6. Commit and push your changes, then make a pull request from Github. + + git commit --signoff + git push -f + +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.