Index: base/containers/README.md |
diff --git a/base/containers/README.md b/base/containers/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..b9f382971bebc61fefb1d49e5c49d5e159be759f |
--- /dev/null |
+++ b/base/containers/README.md |
@@ -0,0 +1,19 @@ |
+# base/containers library |
+ |
+This directory contains some STL-like containers. |
+ |
+Things should be moved here that are generally applicable across the code base. |
+Don't add things here just because you need them in one place and think others |
+may someday want something similar. You can put specialized containers in |
+your component's directory and we can promote them here later if we feel there |
+is broad applicability. |
+ |
+## Design and naming |
+ |
+Containers should adhere as closely to STL as possible. Functions and behaviors |
+not present in STL should only be added when they are related to the specific |
+data structure implemented by the container. |
+ |
+For STL-like containers our policy is that they should use STL-like naming even |
danakj
2017/04/18 21:35:50
Can you explain that for methods is only when thei
|
+when it may conflict with the style guide. So functions and class names should |
+be lower case with underscores. Be sure to use the base namespace. |