Thank you for considering contributing to MusicBrainz Server.
Get started with https://musicbrainz.org/doc/Development first, then continue reading the additional guidelines below.
Some more general guidelines (not complete yet) are available at https://github.com/metabrainz/guidelines/ too.
Please follow the generally accepted seven rules of a great Git commit message:
- 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
Additionally, start the subject line with a ticket reference if applicable.
If your change is large or relevant to users, it should have a ticket
in our issue tracker.
Create one if necessary.
Reference it with its key MBS-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.
Describe your change with a short imperative title, such as
Change small unnoticeable bits
If your change resolves a ticket (see above), please make sure you
prefix your pull request title with MBS-XXX: in order for our issue tracker
to link your pull request to that ticket, such as in
MBS-1234567: Change things relevant to users
If it partially resolves a ticket, use parenthesis, such as in
MBS-1234567 (I): Make first part of needed changes
If your change relate to several tickets, separate these with commas, such as in
MBS-1234567, MBS-2345678: Change two related things at once
Just follow our pull request template.
If your change relates to a ticket, make sure to mention it in the comment, for example
# Summary
Fix MBS-1234567: Change things relevant to users