CONTRIBUTING.md

Contributing Guidelines

Table of Contents

• Pull Request Checklist
• Coding Style
• Contribution Guidelines and Standards

Pull Request Checklist

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

• Read contributing guidelines.
• Read Code of Conduct.
• Ensure you have signed the Contributor License Agreement (CLA).
• Check if my changes are consistent with the guidelines.
• Changes are consistent with the Coding Style.
• Run Unit Tests.

How to become a contributor and submit your own code

Contributor License Agreements

For any code changes to be accepted, the Contributor License Agreement (CLA) must be signed.

Coding Style

To keep a consistent code style, we use Google's Coding Style Guide.

Contribution Guidelines and Standards

Before sending your pull request for review, make sure your changes are consistent with the guidelines and follow the Google coding style.

We adhere to the principles of Google's TensorFlow philosophy for contribution.

License

Include a license at the top of new files.

• Go license example
• Rust license example
• Python license example

To ensures, source code files have copyright license headers you can use Google's addlicense.

Git

Commit Message Guidelines

We prefer Angular's Commit Message Guidelines rules over how our git commit messages can be formatted.

Git ignore

The local .gitignore file contains rules for ignoring project-specific files, while others should go into a global .gitignore file.

Pre-commit hooks

For managing and maintaining pre-commit hooks we use Yelp's pre-commit.