[Pkg-owncloud-commits] [owncloud-doc] 253/270: Update codingguidelines.rst

David Prévot taffit at moszumanska.debian.org
Thu Jul 31 03:53:37 UTC 2014


This is an automated email from the git hooks/post-receive script.

taffit pushed a commit to branch master
in repository owncloud-doc.

commit 4cc8a1757088a65d26f876c3d686062b2a92a8f4
Author: Jos Poortvliet <jospoortvliet at gmail.com>
Date:   Thu Jul 24 14:39:32 2014 +0200

    Update codingguidelines.rst
    
    Add stuff mentioned in https://github.com/owncloud/documentation/issues/382
---
 developer_manual/general/codingguidelines.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/developer_manual/general/codingguidelines.rst b/developer_manual/general/codingguidelines.rst
index bbeaa7d..da1b45e 100644
--- a/developer_manual/general/codingguidelines.rst
+++ b/developer_manual/general/codingguidelines.rst
@@ -14,18 +14,20 @@ General
 * End of Lines : Unix style (LF / '\n') only
 * No global variables or functions
 * Unit tests
+* HTML should be HTML5 compliant
+* Check these `database performance tips <http://mailman.owncloud.org/pipermail/devel/2014-June/000262.html>`_
 * Software should work. Only put features into master when they are complete. It's better to not have a feature instead of having one that works poorly.
 * Regularly reset your installation to see how the first-run experience is like. And improve it.
 * When you ``git pull``, always ``git pull --rebase`` to avoid generating extra commits like: *merged master into master*
-* We need a signed contributor agreement from you to commit into the core repository. But no worries; it's a nice one. All the information is in our `Contributor agreement FAQ <http://owncloud.org/about/contributor-agreement>`_.
+* We need a signed contributor agreement from you to commit into the core repository (apps don't need that). All the information is in our `Contributor agreement FAQ <http://owncloud.org/about/contributor-agreement>`_.
 
 User interface
 --------------
 * Software should get out of the way. Do things automatically instead of offering configuration options.
 * Software should be easy to use. Show only the most important elements. Secondary elements only on hover or via Advanced function.
-* User data is sacred. Provide undo instead of asking for confirmation
+* User data is sacred. Provide undo instead of asking for confirmation - `which might be dismissed <http://www.alistapart.com/articles/neveruseawarning/>`_
 * The state of the application should be clear. If something loads, provide feedback.
-* Do not adapt broken concepts (for example design of desktop apps) just for the sake of consistency. We provide a better interface.
+* Do not adapt broken concepts (for example design of desktop apps) just for the sake of consistency. We aim to provide a better interface, so let's find out how to do that!
 * Ideally do `usability testing <http://jancborchardt.net/usability-in-free-software>`_ to know how people use the software.
 * For further UX principles, read `Alex Faaborg from Mozilla <http://uxmag.com/articles/quantifying-usability>`_.
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud-doc.git



More information about the Pkg-owncloud-commits mailing list