Authors: Tony Lambregts <tony_lambregts@telusplanet.net>, Jonathan Ernst, <Jonathan@ernstfamily.ch>
Update TODO and add a CODING_STANDARD document.
This commit is contained in:
65
CODING_STANDARD
Normal file
65
CODING_STANDARD
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
WineHQ Application Database Coding Practice
|
||||||
|
|
||||||
|
########
|
||||||
|
# HTML #
|
||||||
|
########
|
||||||
|
- Respect html coding standards. The current doctype is HTML 4.01 transitional (http://www.w3.org/TR/REC-html40/)
|
||||||
|
Try to make your content validate nicely (http://validator.w3.org/)
|
||||||
|
|
||||||
|
- Think about upward compatibility. Some day we might choose another doctype like XHTML 1.0
|
||||||
|
(i.e. <br /> instead of <br>, avoid using styles tag and properties (bgcolor, borders & Co) and use stylesheets instead)
|
||||||
|
|
||||||
|
|
||||||
|
#######
|
||||||
|
# PHP #
|
||||||
|
#######
|
||||||
|
- functions are written this way (that way {}'s are lined up):
|
||||||
|
<?
|
||||||
|
function foo()
|
||||||
|
{
|
||||||
|
if(isset($var))
|
||||||
|
{
|
||||||
|
echo "bar";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
|
||||||
|
- indentation is made of 4 spaces (no tabs please)
|
||||||
|
|
||||||
|
- line length should be no more than 130 characters, preferably < 80
|
||||||
|
|
||||||
|
- comments: Muli line code should look like this.
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This functions does nothing interesing.
|
||||||
|
* More comments to come here...
|
||||||
|
*/
|
||||||
|
function bar()
|
||||||
|
{
|
||||||
|
foo();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If you want to highlight some thing this is permissable. for a single line
|
||||||
|
*/
|
||||||
|
|
||||||
|
if(!isset($appId))
|
||||||
|
{
|
||||||
|
/* a single comment should be like this */
|
||||||
|
} else
|
||||||
|
{
|
||||||
|
|
||||||
|
/* Shows a particular version. */
|
||||||
|
if($versionId)
|
||||||
|
{
|
||||||
|
/* Code comes here */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Shows an apps summary */
|
||||||
|
else
|
||||||
|
{
|
||||||
|
/* Another code comes here */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
26
TODO
26
TODO
@@ -1,9 +1,23 @@
|
|||||||
WineHQ Application Database
|
WineHQ Application Database TODO List
|
||||||
TODO List
|
|
||||||
|
|
||||||
+ appdb engine
|
# appdb engine - clean up the php backend (???)
|
||||||
- clean up the php backend
|
|
||||||
|
|
||||||
+ app queue
|
# app queue - add a form, so the admin can enter a custom response to the submitter (done)
|
||||||
- add a form, so the admin can enter a custom response to the submitter
|
|
||||||
|
|
||||||
|
# main App should have a random screenshot from it's versions. (patch sent to wine-patches)
|
||||||
|
|
||||||
|
# when we delete a comment there should be a box to explain why you are deleting this comment and an email should be sent to the submitter
|
||||||
|
|
||||||
|
# Super Maintainers should be able to edit the main app and send a notify message like the versions have.
|
||||||
|
|
||||||
|
# Add Maintainer rating system to the app verision (tony's working on it).
|
||||||
|
|
||||||
|
# stop annoymous comments (patch sent to wine-patches)
|
||||||
|
|
||||||
|
# stop annoymous applications submitions (patch sent to wine-patches)
|
||||||
|
|
||||||
|
# revamp the star rating system
|
||||||
|
|
||||||
|
# once maintainer rating system is in place revamp the front page to use a dynamic list of maintainer rated apps.
|
||||||
|
|
||||||
|
# add a system that well allow users to monitor an app without becoming a maintainer.
|
||||||
|
|||||||
Reference in New Issue
Block a user