Contributor Guidelines

Thanks for helping to improve redpesk ! This page provides a general guide on making contributions to redpesk. If you can’t find something on this page, please feel free to contact the mailing list.

<!– TODO

Prerequisites

Before contributing to redpesk, please complete the following steps:

  1. Create an account on identity.redpesk.org to get started.
  2. Join the mailing list.
  3. Setup your Gerrit account, as described in the Gerrit Tutorial from mediawiki

Working with redmine

Issues for redpesk are hosted in the redpesk Redmine server. When reporting issues, please follow these guidelines.

Claiming Issues

TODO…

Submitting Code

Patch Review and Merge Policy

Push changes for review to redpesk

Git Commit Messages

You are highly encouraged to describe your git commit with enough detail for someone else to understand it. In doing so, your commit message can consist of multiple lines. However, it also is highly encouraged that the first line of your commit message not exceed 50 characters. This is because some of the tooling that sits on top of git (such as the httpd apps that let you browse the repos) assumes that the first line is top-level summary that is 50 characters or less. Thus there will be highlighting and truncating of the commit message using these assumptions and it will look weird if these assumptions are not kept. There should also be a blank line between the summary and any further description.

If the commit is related to a redmine issue, you can specify ‘Bug-RP: ‘ followed by the issue number.

For example, here is a good commit message:

Fixed documentation

Bug-RP: 1234

- added more examples into xyz section
- corrected the documentation.