Contributing guidelines for Meta* projects

MetaBrainz
1

IMHO, all metabrainz projects should have a CONTRIBUTING.md file on github describing the guidelines for contribution.

We should set specific guidelines (preferably project wise) on the code style, the docstring styles, expected git workflow and commit messages.

This will help improve both contributing and maintaining all the projects.

Maybe we can also define UI guidelines for the projects as well for a more consistent experience.

Thoughts and further discussion appreciated :slight_smile:

2 Likes
2

It might be welcome especially for the newer brainz. For larger existing codebases, using the same style as surrounding code seems obvious/straightforward, and it’s also usually fairly easy to fix as part of the PR process.

For GUI stuff and images, I think it would certainly be useful to have sone good description of the “house style” of each project.