Skip to content

Latest commit

 

History

History
78 lines (41 loc) · 3.29 KB

CONTRIBUTING.rst

File metadata and controls

78 lines (41 loc) · 3.29 KB
Raw

Contribution guide

Thank you for considering to contribute to rosbags. Below is information on how to report issues and submit your contributions to rosbags.

Rights to and license of contributions

Rosbags is licensed under Apache 2.0. Your submission of an issue, merge request, comment, or code to us is:

  1. If your employer has rights in your contributions, your representation that your employer has authorized you to enter into this agreement on its behalf;
  2. Your agreement, or your employer's agreement, with the terms and conditions in this document;
  3. Your signature of the Developer Certificate of Origin; and
  4. Your grant of a license to your contributions under Apache 2.0.

Contributing code / merge requests

In order to contribute code there are a few noteworthy things:

  1. Especially for non-trivial contributions, please submit an issue first to discuss your ideas.
  2. If your merge requests relates to an existing issue, please reference it from your merge request.
  3. When creating a merge request, please allow collaboration. This enables us to make small adjustments and rebase the branch as needed. Please use dedicated branches for your merge request and don't give us access to a branch that is dear to you.
  4. Stick to The seven rules of a great Git commit message (see below).
  5. We require you to sign-off your commits (see below). Your sign-off indicates that you agreed to the terms and conditions laid out in this document, if applicable on behalf of your employer.

The seven rules of a great Git commit message

We like The seven rules of a great Git commit message, summarized here for completeness, follow links for further reading.

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters (soft-limit 50, hard-limit 72)
  3. Start subject line with uppercase letter
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

Signing off a commit

You sign off a commit by adding a line like the following to the bottom of its commit message, separated by an empty line.

Signed-off-by: Fullname <email@example.net>

Make sure it reflects your real name and email address. Git does this automatically when using git commit -s.

Except for the licenses granted herein, you reserve all right, title, and interest in and to your contributions.