Add Contributing guidelines in the source code

• Sep 12, 2016 - 17:20
Reported version
3.0
Type
Functional
Severity
S5 - Suggestion
Status
closed
Regression
No
Workaround
No
Project
MuseScore

Some developers get in touch with MuseScore via github and the source code. We should make a CONTRIBUTING file with some explanations. Some things to consider

* Better to discuss new features on the forum first
* Link to the issue tracker
* Link to the license and the CLA
* Link to git workflow
* Link to developer handbook and compilation instructions

Anything else?

Comments

• Sep 12, 2016 - 19:30

Indentation! The tab = 6 spaces is unusual, as is the way curly braces are tabbed in. It may seem small, but it causes time-wasting churn in the PRs (at least it has for me). Good idea to emphasize it up front. Just because you see that everything around you is indented differently doesn't mean you think to do it the same yourself, especially if you are adding isolated blocks of code.

People should know that there are guidelines like this that are strictly enforced. You need to clearly separate Rules from Guidelines.

Reply