Difference between revisions of "Commit Digest/Guidelines"

Jump to: navigation, search
(add to introductory text and specific guidelines)
(add some more review guidelines, add inclusion guidelines)
Line 1: Line 1:
 
==Goal of this page==
 
==Goal of this page==
  
Composing better inclusion guidelines for reviewing commits for the Commit Digest. The source of the original guidelines can be found [https://github.com/dannyakakong/Enzyme/wiki/Inclusion-Guidelines-%28Review%29 here].
+
Composing better guidelines for reviewing and classifying commits for the Commit Digest. The source of the original inclusion guidelines can be found [https://github.com/dannyakakong/Enzyme/wiki/Inclusion-Guidelines-%28Review%29 here].
  
==Original Guidelines==
+
==Original Inclusion Guidelines==
  
 
There is no definitive set of rules when to include a commit message and when not. However, the following gives some guidelines.
 
There is no definitive set of rules when to include a commit message and when not. However, the following gives some guidelines.
Line 20: Line 20:
 
# are about unit tests ( http://en.wikipedia.org/wiki/Unit_testing )
 
# are about unit tests ( http://en.wikipedia.org/wiki/Unit_testing )
  
==New Guidelines==
+
==New Inclusion Guidelines==
  
 
On average about 5% of all commits in a week will be included in the commit digest. This means that those who review the commits should choose carefully which commits should be included. To get a feeling for which messages should or should not be included, it could be useful to read existing Commit Digest to see what kind of commits they contain. There is no definitive set of rules when to include a commit message and when not. However, the following gives some guidelines.
 
On average about 5% of all commits in a week will be included in the commit digest. This means that those who review the commits should choose carefully which commits should be included. To get a feeling for which messages should or should not be included, it could be useful to read existing Commit Digest to see what kind of commits they contain. There is no definitive set of rules when to include a commit message and when not. However, the following gives some guidelines.
Line 40: Line 40:
  
 
Specific guidelines:
 
Specific guidelines:
# Most of the commits to the directory http://websvn.kde.org/trunk/kdesupport/emerge/ are related to build fixes for KDE on Windows. In general they should not be included unless they are to be judged important based on their description.
+
# Commits to the http://websvn.kde.org/trunk/kdesupport/emerge/ directory are mostly related to build fixes for KDE on Windows. In general they should not be included unless they are to be judged important based on their description.
# Often you can see commits related to accounts of developers taking place in /trunk/kde-common/accounts, these commits should be excluded.
+
# Often you can see commits related to accounts of developers taking place in http://websvn.kde.org/trunk/kde-common/accounts/, these commits should be excluded.
 
# If work on new icons is being done there can be a high frequency of commits related to them. Only include the most relevant commits stating for example that all 32x32 icons are done or if the last of the icons are committed. A maximum of three of those repeated messages are desirable for a Commit Digest. Because it can be difficult to see in advance if an icon related commit will be the last one for a specific week, the best compromise is to select the last commit in a series of commits related to icons.
 
# If work on new icons is being done there can be a high frequency of commits related to them. Only include the most relevant commits stating for example that all 32x32 icons are done or if the last of the icons are committed. A maximum of three of those repeated messages are desirable for a Commit Digest. Because it can be difficult to see in advance if an icon related commit will be the last one for a specific week, the best compromise is to select the last commit in a series of commits related to icons.
# What do we with reverts of commits?
+
 
 +
===Uncertain===
 +
 
 +
# Commits which change the contents of the files called NEWS, AUTHORS, Changelog, README and TODO should be excluded.
 +
# Commits which increase the version number (for alpha and beta versions) should be excluded, unless it's for a new release (or not for new releases either? comment please?).
 +
# What do we with reverts of commits? For example removal of code (is that considered refactoring which should be removed according to guidelines), or more specific commits which remove a feature because the feature is not considered ready for the next stable release?
 +
# What do we do with the commits which often occur since the migration to Git which mention a branch merge?
 +
 
 +
==Classification Guidelines==
 +
 
 +
Bug Fixes: this category contains all commits which mention a bug number in the message. It also contains commits which fix something according to the comment but don't have a bug report attached (these commits need to be important though, remember the 5% rule!).
 +
 
 +
Optimize: this category is only meant for commits that make things either faster, use less memory, or in rare cases, make the interface more streamlined ("now this can be done in 2 clicks instead of 10").
 +
 
 +
Other: this category is for commits that don't really fit anywhere else: for example for commits that are really interesting or funny even if they otherwise wouldn't be important (like someone writing in the message that they learned something really important, etc.).
 +
 
 +
Specific guidelines:
 +
 
 +
New icons and other new artwork should be classified under the area 'User Interface' and under the type 'Feature'.

Revision as of 11:09, 31 December 2010

Goal of this page

Composing better guidelines for reviewing and classifying commits for the Commit Digest. The source of the original inclusion guidelines can be found here.

Original Inclusion Guidelines

There is no definitive set of rules when to include a commit message and when not. However, the following gives some guidelines.

Hint: you can always investigate a commit further by clicking on the commit id. This gives you helpful details about which files were modified and allows for a line by line comparison of the source code.

In general add messages to the Commit Digest if they:

  1. are interesting (in general these messages have a longer text describing them),
  2. fix a bug, are an optimization or add a feature (for the user); this is in particular the case when there is a "broken box" symbol in the lower right corner of the message,
  3. new or significantly improved icons.

Generally do not include messages if they:

  1. are back-ports, i.e., the message basically appears two times (then do not include the backported version),
  2. are refactorings, internal clean-ups, additions to the API (unless they seem to be interesting, e.g., a whole new API for Nepomuk),
  3. are about CMake or desktop files, documentation changes (w/o bug number)
  4. are about unit tests ( http://en.wikipedia.org/wiki/Unit_testing )

New Inclusion Guidelines

On average about 5% of all commits in a week will be included in the commit digest. This means that those who review the commits should choose carefully which commits should be included. To get a feeling for which messages should or should not be included, it could be useful to read existing Commit Digest to see what kind of commits they contain. There is no definitive set of rules when to include a commit message and when not. However, the following gives some guidelines.

Hint: you can always investigate a commit further by clicking on the commit id. This gives you helpful details about which files were modified and allows for a line by line comparison of the source code.

In general add messages to the Commit Digest if they:

  1. are interesting (in general these messages have a longer text describing them),
  2. fix a bug, are an optimization or add a feature (for the user); this is in particular the case when there is a "broken box" symbol in the lower right corner of the message,
  3. new or significantly improved icons.

Generally do not include messages if they:

  1. are back-ports, i.e., the message basically appears two times (then do not include the backported version),
  2. are refactorings, internal clean-ups, additions to the API (unless they seem to be interesting, e.g., a whole new API for Nepomuk),
  3. are about CMake or desktop files, documentation changes (without bug number),
  4. are about unit tests ( http://en.wikipedia.org/wiki/Unit_testing ),
  5. are fixes or additions to a localization (without bug number)
  6. introduce trivial changes such as the resizing of a line-edit or changes in button placement.

Specific guidelines:

  1. Commits to the http://websvn.kde.org/trunk/kdesupport/emerge/ directory are mostly related to build fixes for KDE on Windows. In general they should not be included unless they are to be judged important based on their description.
  2. Often you can see commits related to accounts of developers taking place in http://websvn.kde.org/trunk/kde-common/accounts/, these commits should be excluded.
  3. If work on new icons is being done there can be a high frequency of commits related to them. Only include the most relevant commits stating for example that all 32x32 icons are done or if the last of the icons are committed. A maximum of three of those repeated messages are desirable for a Commit Digest. Because it can be difficult to see in advance if an icon related commit will be the last one for a specific week, the best compromise is to select the last commit in a series of commits related to icons.

Uncertain

  1. Commits which change the contents of the files called NEWS, AUTHORS, Changelog, README and TODO should be excluded.
  2. Commits which increase the version number (for alpha and beta versions) should be excluded, unless it's for a new release (or not for new releases either? comment please?).
  3. What do we with reverts of commits? For example removal of code (is that considered refactoring which should be removed according to guidelines), or more specific commits which remove a feature because the feature is not considered ready for the next stable release?
  4. What do we do with the commits which often occur since the migration to Git which mention a branch merge?

Classification Guidelines

Bug Fixes: this category contains all commits which mention a bug number in the message. It also contains commits which fix something according to the comment but don't have a bug report attached (these commits need to be important though, remember the 5% rule!).

Optimize: this category is only meant for commits that make things either faster, use less memory, or in rare cases, make the interface more streamlined ("now this can be done in 2 clicks instead of 10").

Other: this category is for commits that don't really fit anywhere else: for example for commits that are really interesting or funny even if they otherwise wouldn't be important (like someone writing in the message that they learned something really important, etc.).

Specific guidelines:

New icons and other new artwork should be classified under the area 'User Interface' and under the type 'Feature'.


Content is available under Creative Commons License SA 4.0 unless otherwise noted.