Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

70 lines (45 loc) · 2.24 KB
Raw

Contributing to Search Index Rebuilder (SIR)

Thank you for considering contributing to Search Index Rebuilder (SIR).

Some more general guidelines (not complete yet) are available at https://github.com/metabrainz/guidelines/ too, more particularly about MeB GitHub/Jira workflow and Python programming guidelines.

Submitting changes

Commit message

Please follow the generally accepted seven rules of a great Git commit message:

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  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

Additionally, start the subject line with a ticket reference if applicable.

Pull request

Ticket

If your change is large or relevant to users, it should have a ticket in our issue tracker. Create one if necessary, in the component “Indexer”. Reference it with its key SEARCH-XXX. It will be used to follow the progress of the change and to generate the release notes that are made available to users on the blog.

Untracked changes are typos, comments, coding style changes, automated dependency updates, unnoticeable refactoring, and so on.

Title

Describe your change with a short imperative title, e.g.

Change small unnoticeable bits

If your change resolves a ticket (see above), please make sure you prefix your pull request title with SEARCH-XXX: in order for our issue tracker to link your pull request to that ticket, e.g.

SEARCH-1234567: Change things relevant to users

If it partially resolves a ticket, use parenthesis, e.g.

SEARCH-1234567 (I): Make first part of needed changes

If your change relate to several tickets, separate these with commas, e.g.

SEARCH-1234567, SEARCH-2345678: Change two related things at once

Comment

Just follow our pull request template.

If your change relates to a ticket, make sure to mention it in the comment, e.g.

# Summary

Fix SEARCH-1234567: Change things relevant to users