Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

80 lines (51 loc) · 3.15 KB
Raw

Contributing guidelines

Pull Request Checklist

Before sending your pull requests, make sure you followed this list.

How to become a contributor and submit your own code

Contributor License Agreements

We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.

Please fill out either the individual or corporate Contributor License Agreement (CLA).

  • If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an individual CLA.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.

NOTE: Only original source code from you and other people that have signed the CLA can be accepted into the main repository. (Note: we need to modify this to allow third party code under Apache2 or MIT license with additional review.)

Contributing code

If you have improvements to MLPerf, send us your pull requests! For those just getting started, Github has a howto.

Contribution guidelines and standards

(Note: Technical details TBD by community.)

General guidelines and philosophy for contribution

(Note: Technical details TBD by community.)

License

Include a license at the top of new files.

Coding styles

The code was originally contributed by Google so it conforms to the Google C++ Style Guide and Google Java Style Guide.

The format_code.sh script is the convinent way to format your files. It uses the clang-format for checking your C/C++ files, buildifier for bazel files and google-java-format for Javafiles. To install its dependencies, do:

sudo apt install clang-format
go get github.com/bazelbuild/buildtools/buildifier

Then you can format your files by running:

bash format_code.sh

Optionally, you can add it to pre-commit hook by running:

sed -i -e '$a\' -e 'bash `git rev-parse --show-toplevel`/format_code.sh && git add *' \
-e "/format_code.sh/d" .git/hooks/pre-commit

Running sanity check

(Note: Technical details TBD by community.)

Running unit tests

(Note: Technical details TBD by community.)