Skip to content

Commit

Permalink
docs(contributing): add contributing_en.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sunYanxl committed Jul 18, 2018
1 parent 2079362 commit 2b4e656
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ feature/bugfix PR
### PR流程
TSW团队会查看所有的PR,我们会运行一些代码检查和测试,一经测试通过,我们会接受这次PR,但不会立即将代码合并到master分支上,会有一点延迟。

当您准备拉请求,请确保已经完成以下几个步骤:
当您准备pull requests时,请确保已经完成以下几个步骤:

1. 将仓库fork下来并基于`master`分支创建您的开发分支。
2. 如果您更改了APIs请更新代码及文档。
Expand Down
49 changes: 49 additions & 0 deletions CONTRIBUTING_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing to TSW
Welcome to [report Issues](https://github.com/Tencent/TSW/issues) or [pull requests](https://github.com/Tencent/TSW/pulls). It's recommended to read the following Contributing Guide first before contributing.

## Issues
We use Github Issues to track public bugs and feature requests.

### Search Known Issues First
Please search the existing issues to see if any similar issue or feature request has already been filed. You should make sure your issue isn't redundant.

### Reporting New Issues
If you open an issue, the more information the better. Such as detailed description, code blocks of your problem.

## Pull Requests
We strongly welcome your pull request to make TSW better.

### Branch Management
There are two main branches here:

1. `master` branch.
1. **Don't submit any PR on `master` branch.**
2. `dev` branch.
1. It is our stable developing branch. After full testing, `dev` will be merged to `master` branch for the next release.
2. **You are recommended to submit bugfix or feature PR on `dev` branch.**

Normal bugfix or feature request should be submitted to `dev` branch. After full testing, we will merge them to `master` branch for the next release.

```
master
dev
feature/bugfix PR
```

### Make Pull Requests
The code team will monitor all pull request, we run some code check and test on it. After all tests passed, we will accecpt this PR. But it won't merge to `master` branch at once, which have some delay.

Before submitting a pull request, please make sure the followings are done:

1. Fork the repo and create your branch from `master`.
2. Update code or documentation if you have changed APIs.
3. Add the copyright notice to the top of any new files you've added.
4. Check your code lints and checkstyles.
5. Test and test again your code.
6. Now, you can submit your pull request on `dev`.

## License
By contributing to TSW, you agree that your contributions will be licensed
under its [MIT LICENSE](https://github.com/Tencent/TSW/blob/master/LICENSE)

0 comments on commit 2b4e656

Please sign in to comment.