Skip to content

Commit

Permalink
docs: contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
changlan authored and ymjiang committed Jul 23, 2019
1 parent 77eea67 commit 2aba9f0
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Contribution guidelines

First of all, thanks for taking the time to contribute!

Please refer to the following guidelines to contribute new functionality or bug fixes:

1. Use [autopep8](https://github.com/hhatto/autopep8) to format the Python code.
2. Use [clang-format](https://clang.llvm.org/docs/ClangFormat.html) to format C++ code. Changes to BytePS C++ code should conform to [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
3. Add unit tests for any new code you write.
4. Run unit tests in both CI and GPU environments.

0 comments on commit 2aba9f0

Please sign in to comment.