同步操作将从 ApolloAuto/apollo 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
You are welcome to contribute to project Apollo. To contribute to apollo, you have to agree with the Apollo individual contributor license agreement.
For each new file, please include a license at the top of the file.
C++ code License example util.h;
Python code License example process.py;
Bash code License example apollo_base.sh;
Please include unit tests for the contributed code to prove that your code works correctly,
and make sure that your code does not break existing tests. Test files are always named to end with _test.cc
, and the test target names in the BUILD file always end with test
.
Here is an example test file file_test.cc.
You can use command bash apollo.sh test
to run all unit tests.
C/C++ coding style: Apollo adopted the Google C++ Style Guide. Make sure your code conforms to this style guide. You can use command bash apollo.sh lint
to check if your code has any style problem.
Python coding style: Apollo adopted the Google Python Style Guide. You can use the yapf command yapf -i --style='{based_on_style: google}' foo.py
to format a file foo.py.
Apollo best coding practice: Please also refer to Apollo Best Coding Practice for more coding practice disciplines.
BUILD coding style : you can use command bash apollo.sh buildify
to format your BUILD files before you submit.
If your code is not straightforward for other contributors to understand, it is recommended to implement the code in a clear and efficient way, and provide sufficient comments and documentation.
Apollo uses doxygen to help generate formatted API Document with command bash apollo.sh doc
.
Document your code following this guide How to document code.
The first line of commit message should be a one-line summary of the change. A paragraph can be added following the summary to clearly explain the details of the change. If your code fixed an issue, add the issue number to your commit message. An example of a good commit message is:
Replaced algorithm A with algorithm B in apollo/modules/control.
Algorithm B is faster than A because it uses binary search. The runtime is reduced from O(N) to O(log(N)).
Fixes #1234
After you finish your code and ready to create a Pull Request, please make sure your
change don't break build/test/lint by running bash apollo.sh check
, which is
equivalent to a combination of bash apollo.sh build
, bash apollo.sh test
and
bash apollo.sh lint
.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。