Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (33 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

45 lines (33 loc) · 1.5 KB

Contributing

Feedback and contributions are welcome.

General information

For specific proposals or change requests, please use the issues and pull requests pages on the Gitlab site. For general discussion or support, feel free to join the conversation on Gitter.

License

All contributed material must be released under the MIT license.

Code style

Reformat code using clang-format before committing. Refer to clang-format specification for specific details.

Git commit style

A good reference for commit style is Chris Beams blog post. Main points:

  • Separate subject from body with an blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Don't end the subject line with a period
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use the body to explain what and why vs. how

Commits aren't required to be GPG signed or signed-off, but it's not discouraged either.