OganizationConventions » History » Version 8
J. Wienke, 02/27/2012 06:21 PM
1 | 1 | J. Moringen | h1. OganizationConventions |
---|---|---|---|
2 | 1 | J. Moringen | |
3 | 7 | J. Wienke | _Feel free to add any thoughts or suggestions._ |
4 | 1 | J. Moringen | |
5 | 1 | J. Moringen | h2. Naming |
6 | 1 | J. Moringen | |
7 | 3 | J. Wienke | * Do not include artifacts of the current communication pattern for one type. I.e. if you currently send events of images, your type must not be @ImageEvent@, but solely @Image@, as the @Image@ type might later be reused in an RPC communication. |
8 | 5 | J. Wienke | * java_outer_class_name will always be @<file name w/o ext>Type@ |
9 | 5 | J. Wienke | * Follow the rules in http://code.google.com/intl/de-DE/apis/protocolbuffers/docs/style.html |
10 | 4 | J. Wienke | |
11 | 1 | J. Moringen | h2. Directory Layout |
12 | 1 | J. Moringen | |
13 | 1 | J. Moringen | The current policy for filenames of data definitions in RST is as follows: |
14 | 6 | J. Wienke | * The directory (relative to the @proto/{stable,sandbox}@ directory in the project root) in which the proto-file resides must match the package name with all "."s replaced with "/"s |
15 | 6 | J. Wienke | * The filename must match the name of the "primary" message definition (with ".proto" appended) |
16 | 1 | J. Moringen | * There should only be one "primary" message definition in each proto-file |
17 | 2 | J. Wienke | ** Groups of related messages should reside in individual files and refer to each other using @import@ |
18 | 6 | J. Wienke | * Directory names are all lowercase and without word separations, e.g. @imageprocessing@. |
19 | 1 | J. Moringen | |
20 | 1 | J. Moringen | h2. Rationale |
21 | 1 | J. Moringen | |
22 | 1 | J. Moringen | * Facilitate easy documentation and reuse via @import@ |
23 | 1 | J. Moringen | * Data definitions can be treated as resources with unique URLs |
24 | 1 | J. Moringen | ** These URLs can be derived from a qualified message name |
25 | 1 | J. Moringen | E.g. @.rst.ImageMessage -> https://code.cor-lab.org/svn/rst/trunk/proto/rst/ImageMessage.proto@ |
26 | 8 | J. Wienke | |
27 | 8 | J. Wienke | h2. Automatic Checking |
28 | 8 | J. Wienke | |
29 | 8 | J. Wienke | Is performed in a "CI job":https://ci.cor-lab.de/job/rst-trunk-static-analysis/. |