Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 1.06 KB

Contributing

  1. Setup git and git send-email
  2. Send patches to [email protected] along with a cc to the mailing list [email protected]
  3. One commit per patch
  4. Create an issue before sending the patch
  5. Commit messages must be of the form:
shortlog: commit message

commit body

fixes #<issue_number>

Signed-off-by: [Your name] <your email>

Note: add the git commit --signoff flag while committing to get the Signed-off-by line added

  1. Use proper commit messages. Refer this, mainly:
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not 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
  1. Coding style: Follow google's coding style.