CONTRIBUTING.md 1.52 KB
Newer Older
gejun's avatar
gejun committed
1
If you meet any problem or request a new feature, you're welcome to [create an issue](https://github.com/brpc/brpc/issues/new/choose).
2 3 4 5 6 7 8 9 10 11 12

If you can solve any of [the issues](https://github.com/brpc/brpc/issues), you're welcome to send the PR to us.

Before the PR:

* Make sure your code style conforms to [google C++ coding style](https://google.github.io/styleguide/cppguide.html). Indentation is preferred to be 4 spaces.
* The code appears where it should be. For example the code to support an extra protocol should not be put in general classes like server.cpp, channel.cpp, while a general modification would better not be hidden inside a very specific protocol.
* Has unittests.

After the PR:

13
* Make sure the [travis-ci](https://travis-ci.org/apache/incubator-brpc/pull_requests) passed.
14 15 16

# Chinese version

gejun's avatar
gejun committed
17
如果你遇到问题或需要新功能,欢迎[创建issue](https://github.com/brpc/brpc/issues/new/choose)
18

gejun's avatar
gejun committed
19
如果你可以解决某个[issue](https://github.com/brpc/brpc/issues), 欢迎发送PR。
20 21 22 23 24 25 26 27 28

发送PR前请确认:

* 你的代码符合[google C++代码规范](https://google.github.io/styleguide/cppguide.html)。缩进最好为4个空格。
* 代码出现的位置和其定位相符。比如对于某特定协议的扩展代码不该出现在server.cpp, channel.cpp这些较为通用的类中,而一些非常通用的改动也不该深藏在某个特定协议的cpp中。
* 有对应的单测代码。

提交PR后请确认:

29
* [travis-ci](https://travis-ci.org/apache/incubator-brpc/pull_requests)成功通过。