C++: Fix some of the parsers to fit the correct inheritance
[smartapi.git] / README
1 Smart API Code repository
2 =============================
3
4 This is the revision controlled code repository of the Smart API semantic library.
5
6 A few housekeeping rules:
7 1) Commit often. It makes your work a lot easier and it improves teamwork if each feature
8    revision has a proper commit. In case something breaks, tracking back the cause is much
9    easier and it is easier to follow the progress.
10
11 2) One feature improvement = one commit. 
12
13 3) Branch if you are uncertain. Branches help you maintain your own test versions in a
14    consistent manner. DON'T take a copy of the code and place it somewhere else on your
15    computer if you do experimental code, use a branch instead. Merging a large copy-paste 
16    of an unknown age back to the main code tree is a pain in the ass. Branches do that 
17    automatically.
18
19 4) Document your commits. Other people will want to know what you did and why so that they
20    can align their own work with yours. "Made a bugfix" is not a proper document of work 
21    performed.
22    
23 5) Avoid committing non-working/non-compiling code into the main branch. Those who pull your
24    bugs and need to fix them before even getting forward in their own work, will not thank you
25    for that.
26    
27 6) Don't commit binaries, libs or anything that is the result of some automated process. And
28    most importantly, don't commit your own, local settings. Keep them in separate files and
29    exclude from the repository. Only code, only sources to the repository.
30    
31 7) If you include a library, avoid committing unnecessary garbage such as test cases or revisions
32    that will not be used by anyone. Core functionality only, please.
33    
34 8) Favor text format. If you include a document, keep it in plain text or similar light weight
35    format. Don't store megabyte sized Word docs into the code repository, One2team the correct
36    place for those.
37    
38 9) Code in this repository is shared code. By default it can be used by other partners without fee.