Loading...
 

Code Review

As per Where, this page should be about general improvements to the Code review feature. Coordination about code.tiki.org should happen on the community site: code.tiki.org



2012-08-08: Work has restarted in trunk with enhancements to ratings and PluginProposal, and will be part of Tiki10. It permits the Quality Team to vote directly on code.tiki.org with dashboards (commits without enough votes, commits that have been voted down, etc.). There are also weights when some votes count more than others.

2010-06-14: Work has started and this is part of Tiki6. You can Dogfood at code.tiki.org and on your own server with the software project profile

Background info


It was brought up in TikiFestStrasbourg that we want a more systematic way to collectively review code commits.

Our vast project relies on enough eyeballs. This means quantity but also diversity. Right now, we don't know if a commit was checked by 6 people and another, by no one. Let's become more efficient.

ImpressCMS has a nifty system. It's a web-based review queue of all commits. Devs can approve, add a comment, ask for rollback, etc. And for everything except approve, an email is triggered to the dev list and the relevant comments are kept in the web-based system. And they connect this to their Trac instance.

This is quite similar to the informal way we do it now. We tend to reply to the SVN commit mailing list with feedback.

And if you are not comfortable to review a commit, you just move on to the next one and let a dev with more experience in that part of the code handle it.

This ticket/case tracking is very similar to the use case for GroupMail. I think it could make great dogfood.

We could also imagine two approve buttons "the fix/feature works" and "the code is of quality and future-proof". This could be useful in the case a programmer doesn't have sample data to test. Programmer could report that code is "right way of doing it" and "it should work" while a power-user who has the data could confirm that the "fix indeed works" and "hasn't broken anything for me".

People could put a special syntax in the commit message that could close the bug, add a note, etc.

This can save the Quality Team a lot of time.

Please see ImpressCMS example

Image
svn commit -m "[FIX] Add new Tiki Coffee feature. Solve #2345" tiki-coffee.php


This should trigger to close the ticket #2345 and add the note, and ideally, a link to SVN: example

Questions

  • What if one of the servers is not accessible? Will it retry ater?


Related

Other apps

alias

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI & 508)
Accounting 7.x
Administration
Ajax 2.x
Articles & Submissions
Backlinks
Banner
Batch 6.x
BigBlueButton audio/video/chat/screensharing (5.x)
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution 2.x
Cookie
Copyright
Credits 6.x
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs 8.x
DogFood
Draw 7.x
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Group
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping 3.x
Mobile Tiki and Voice Tiki
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Payment 5.x
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Score
Search engine optimization (SEO)
Search
Security
Semantic links 3.x
Share
Shopping Cart 5.x
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags 2.x
Task
Tell a Friend, alert + Social Bookmarking
Terms and Conditions
Theme
TikiTests 2.x
Timesheet
Token Access
Toolbar (Quicktags)
Tours
Trackers
TRIM
User Administration
User Files
User Menu
Watch
WebHelp
Webmail and Groupmail
WebServices 3.x
Wiki 3D
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace and perspectives 4.x
WYSIWTSN 4.x
WYSIWYCA
WYSIWYG 2.x
XMLRPC




Useful Tools