summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 95a32ef10..6493979f0 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -546,6 +546,9 @@ prefixed with a single underscore, and are not imported in BuildStream's the mas
In this case, the *"API Private"* functions are prefixed with a single underscore.
+Any objects which are a part of the *"Public API Surface"* should be exposed via the
+toplevel ``__init__.py`` of the ``buildstream`` package.
+
File naming convention
~~~~~~~~~~~~~~~~~~~~~~