History:Checklist For Style Changes: Difference between revisions
From MusicBrainz Wiki
Jump to navigationJump to search
(Tarragons list extended, feel free to enhance (Imported from MoinMoin)) |
(typo (Imported from MoinMoin)) |
||
| Line 20: | Line 20: | ||
</ul> |
</ul> |
||
===Conflicts with other Style |
===Conflicts with other Style Guidelines=== |
||
<ul><li style="list-style-type:none">What is the scope of the affected guideline? Does the [[Style Change|StyleChange]] move the boundaries of this scope? The [[Official Style Guideline|OfficialStyleGuideline]]<code><nowiki></nowiki></code>s form a balanced set. Both extending and reducing the scope of one element can unbalance the whole set. |
<ul><li style="list-style-type:none">What is the scope of the affected guideline? Does the [[Style Change|StyleChange]] move the boundaries of this scope? The [[Official Style Guideline|OfficialStyleGuideline]]<code><nowiki></nowiki></code>s form a balanced set. Both extending and reducing the scope of one element can unbalance the whole set. |
||
Revision as of 00:45, 2 February 2006
Checklist for Changes to the Style Guidelines
This page describes the things that must be checked before a StyleChange is made to the StyleGuidelines. It NeedsIntertwingling, too.
This checklist is just emerging with the (continuing) reorganization of the StyleCouncil and is not complete. Please read the information on the StyleCouncil!
The Council's Secretary (currently DonRedman) will not give an OK to a StyleChange unless this list has been checked. And it is the job of the person who wants the OK, to prove that everything is well.
Checklist
What is the impact on existing data?
- How will the change affect the way data is stored? What is the difference between the way it is stored now and the way it will be stored? How big is the change in SoftStructure? It might very well be that the change resolves some oddities but creates problems for cases that were simple unter the old guideline. Concrete questions are: * Is the change just an addition or or a real change in structure? Do elements get reorganized? * What were the edge cases of the old guideline, and how are these affected? * How will this affect Various Artists albums (an often forgotten problem area).
Conflicts with other Style Guidelines
- What is the scope of the affected guideline? Does the StyleChange move the boundaries of this scope? The OfficialStyleGuideline
s form a balanced set. Both extending and reducing the scope of one element can unbalance the whole set.
Required Editor Time
- How much work by editors is required to implement the change? If this is a lot: Can the change be automated, and is this worth it?
Required Developer Time
- How much work by developers is required to implement the change? Keep in mind that developer time is limited and we wish to avoid wasting their time if at all possible.
Impact on Paying Clients
- Could the change possibly affect paying clients? If so find out if it does. Remember that paying clients do not control what changes we make, but we think of them regarding how we roll out changes.
The initial list was created by TarragonAllen.
