Skip to content
This repository was archived by the owner on Apr 28, 2022. It is now read-only.

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
liudf0716 authored Jun 29, 2017
1 parent 3018e17 commit a36536d
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit a36536d

Please sign in to comment.