~fginther/ubuntu-calculator-app/fix-x-test

« back to all changes in this revision

Viewing changes to README

  • Committer: Bartosz Kosiorek
  • Date: 2014-11-28 14:59:44 UTC
  • Revision ID: gang65@poczta.onet.pl-20141128145944-kruw6p1vbno2xft5
Documentation update

Show diffs side-by-side

added added

removed removed

Lines of Context:
5
5
- Project page: https://launchpad.net/ubuntu-calculator-app
6
6
- Design page:
7
7
  https://docs.google.com/presentation/d/1EiIELGizPHrd0TY7JdNwULbiqPYfOyEEI5CS87n7QlY/edit
 
8
 
 
9
 
 
10
# How to develop
 
11
 
 
12
## Style guide
 
13
 
 
14
General idea above style guide is:
 
15
"All code in any code-base should look like a single person typed it, no matter how many people contributed."
 
16
 
 
17
More information about style guides, and why we need it:
 
18
    http://addyosmani.com/blog/javascript-style-guides-and-beautifiers/
 
19
 
 
20
Curent style guide for ubuntu-calculator-app is:
 
21
    https://github.com/rwaldron/idiomatic.js
 
22
 
 
23
When you creating code, every function/variable name should be meaningful and has easy to understand form. The names should reveal intent of creator. With good names you even do not need an comments. The code is documentting itself. We should avoid comments if it is not necessary.
 
24
If someone during review, ask you to add comment then you should check if names are reveal your intent.
 
25
 
 
26
More information about clean/beautiful code is available in books:
 
27
 * Clean Code: A Handbook of Agile Software Craftsmanship Paperback, by Robert C. Martin
 
28
 * Beautiful Code: Leading Programmers Explain How They Think, by Andy Oram
 
29
 
 
30
## Run the autopilot tests
 
31
 
 
32
Prerequisites:
 
33
    sudo apt-get install ubuntu-ui-toolkit-autopilot
 
34
 
 
35
Once the app has been built, you can go to the build directory and run:
 
36
 
 
37
    cd tests/autopilot
 
38
    autopilot run filemanager