Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
122 lines (80 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

122 lines (80 loc) · 3.21 KB

Contributing guidelines

Style

C++ coding style

Follow Google C++ Style Guide, with max-line-length extended to 100.

Run clang-format before committing code:

clang-format -i <my_cc_file>

Python coding style

Follow Google Python Style Guide with exceptions:

  • max-line-length = 100
  • indent_width = 2
  • Specify argument type in bracket in docstring. For example:
"""USE
Args:
  embedding_width (int): Width of embedding vector
"""

"""DONOT use
Args:
  embedding_width: An `integer`. Width of embedding vector.
"""

Run pylint before committing code.

Install pylint

pip install pylint

To check a file with pylint:

pylint --rcfile=.pylintrc myfile.py

Yapf

yapf is an auto format tool owned by Google (not a Google product). To save the time of arguing code style during code review, use yapf to format the code is a good option. Note that it doesn't reformat comment.

Install yapf

pip install yapf

Format code with yapf

yapf myfile.py --style .style.yapf

There are Sublime and Vim plugins.

Test

Use googletest for c++ code.

Use Tensorflow's test and abseil for python code.

DONOT use mixed case test name, follow the code style.

Miscellaneous

Run pre-commit

pre-commit manages pre git commit hooks. .pre-commit-config.yaml is configured to run coding style and some other checks.

Use abseil

In addition to test, abseil also provides flags and logging which is derived from Tensorflow. We recommend to abseil flags and logging over Python's argparse and logging.

Developer Certificate of Origin (DCO)

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.