Kaladaran/briar
0
0
Fork 0
mirror of https://code.briarproject.org/briar/briar.git synced 2026-02-18 21:59:54 +01:00
Code Issues Projects Releases Wiki Activity

Update pre review checklist

akwizgran
2018-06-02 16:14:15 +00:00
parent f8271c609d
commit c412e03e1f
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
pre-review-checklist.md

@@ -1,13 +1,13 @@
#### Thread safety #### Thread safety
* Classes should be immutable where possible * Classes should be immutable where possible
* Classes that may be used by multiple threads must be thread-safe * Classes that may be used by multiple threads must be thread-safe
* If a class is used by a single thread and is not thread-safe, add a comment * If a class is not thread-safe, annotate it @NotThreadSafe
* Fields that are used by multiple threads must be volatile or guarded by locks * Fields that are used by multiple threads must be volatile or guarded by locks
* If a field or method is guarded by a lock, add a comment * If a field or method is guarded by a lock, add a comment, e.g. `// Locking: foo`
#### Visibility #### Visibility
* Minimise the visibility of classes, fields and methods * Minimise the visibility of classes, fields and methods
* Fields should be private or protected * Fields should usually be private, with getters and setters if needed
* Fields should be final where possible * Fields should be final where possible
* Inner classes should be static where possible * Inner classes should be static where possible