Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

33 lines (25 loc) · 1.74 KB

Contributing to Trellis

First off, thanks for contributing! Please read this guide before making a contribution.

How Can I Contribute?

You can contribute either by reporting bugs/issues, issuing feature requests and enhancements, or code contributions.

Reporting Bugs

When reporting bugs, please provide as much detail and context as possible.

Use a clear and descriptive title for the issue to identify the problem.

How do I submit a bug?

Bugs are tracked as Github Issues.

Create an issue and provide as much of the following information as possible:

  • Operating environment (OS, etc)
  • Environment variables
  • Describe the exact steps to reproduce the problem
  • Describe the observed behavior
  • Describe the expected behavior
  • Include relevant screenshots / diagnostics information

Suggesting Feature or Enhancement Requests

When reporting features or enhancements, please perform a cursory search over the existing requests to make sure one does not already exist. If it does, please add a comment there instead.

How do I submit a feature or enhancement request?

Feature & enhancement requests are tracked as Github Issues

Your First Code Contribution

  • Study the Google C++ Syle Guide for code style conventions.
  • If touching source files, use clang-format with the .clang-format file in this repository to format edited files.
  • If touching BUILD files, use buildifier to format the BUILD file after editing.
  • Issue a pull request with the changeset. Ensure your pull request contains a detailed write up of the explaining the need for the changes. Reference any relevant Github issues.