Using Enzyme

These instructions relate to general use of Enzyme, but are targeted at the instance which powers the KDE Commit-Digest.

If you do not yet have an Enzyme account, please sign up with one @ http://enzyme.commit-digest.org/

Once you have signed up for an account, should have just recieved an automated email from the Enzyme system setting you up as a user to contribute as your chosen role. Also check your spam folder if you cannot find it (and mark as "not spam" if possible!).

As the setup email says, go to http://enzyme.commit-digest.org/ and login using the details provided. You can then change your personal details and password if required by clicking the "Settings" button in the top right corner.

I suggest that you use Firefox for working inside Enzyme, as I have fully tested it - other browsers like Chrome / Chromium work but may have minor issues like buttons not aligned.

The commit week runs from the first minute of Sunday morning for a week, so any commits made on a Sunday appear in the next week's Digest issue.

However, you don't need to wait until Sunday to start reviewing commits! Enzyme will update daily with the most recent commits, allowing you to review them at your own pace. If no commits are showing (and the message "No revisions available" is displayed), this should mean that all the commits available have been reviewed - in this case, please check again the following day.

If this message is not showing and the area is just a blank space, there is probably an error and you should contact me at danny@commit-digest.org

Reviewing

The review interface is AJAX, and uses either keyboard shortcuts or mouse button actions. To get started:

• Go to "Review" in the sidebar
• Press [->] once - the first commit should be highlighted with a red border
• Read the commit message
  • If you think it is worthy for inclusion in the Digest, press [Space] - this selects the message, and highlights with a green border
  • If it is not worthy for selection, just move to the next commit by pressing [->] again
• Once you have read the whole page, or enough for now, press the "Save" button in the bottom right
• If you want to read a previous commit, press [<-]

Beware! Once a commit has been highlighted in red, it has been marked as read, and will not be seen again by anyone once you press "Save". If you wish to unselect the commit, highlight it again and press the [Space] key.

Please only highlight commits that you intend to read and decide whether it should / should not be included.

Classifying

Once some commits have been selected in the review interface, they appear in the classify interface for sorting. Each selected commit gets two boxes, for "area" and "type".

"Area" is the "subproject", like KOffice. "Type" represents bug fixes, features, and so on.

• These boxes need to be filled by you using the dropdown menus (mouse) or with the correct number (keyboard)
• For the keyboard interface, there is a key to the numbers in the bottom left (click the sections to change between them)
• Read the commit message to decide the correct area and type of each commit, then press [Tab] to go to the next box
• Commits will be highlighted green when both boxes have been filled
• Press the "Save" button when you have classified as many as you wish to
• These commits will now appear in the next Commit-Digest

Enzyme is still under development, so please let me know of any problems or feedback at danny@commit-digest.org