From c5cd54e5d884f14bdaec2a71f15014cb195d14a8 Mon Sep 17 00:00:00 2001 From: Serge Latyntcev Date: Tue, 22 Oct 2019 10:51:33 +1300 Subject: [PATCH] DOC RFC-8996 clarify public APIs --- docs/en/05_Contributing/01_Code.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/en/05_Contributing/01_Code.md b/docs/en/05_Contributing/01_Code.md index 82aa2cbc2..643f1df0b 100644 --- a/docs/en/05_Contributing/01_Code.md +++ b/docs/en/05_Contributing/01_Code.md @@ -86,6 +86,21 @@ If you are changing existing APIs, introducing new APIs or major new features, please review our guidance on [supported versions](release_process#supported-versions). You will need to change the branch for your pull request accordingly. +Silverstripe CMS public APIs explicitly include: + - namespaces, classes, interfaces and traits + - public and protected scope (including methods, properties and constants) + - global functions, variables + - yml configuration file structure and value types + - private static class properties (considered to be configuration variables) + +Silverstripe CMS public APIs explicitly exclude: + - private scope (methods and properties with the exception for `private static`) + - entities marked as `@internal` + - yml configuration file default values + - HTML, CSS, JavaScript, TypeScript, SQL and anything else that is not PHP + +Other entities might be considered to be included or excluded from the public APIs on case-by-case basis. + ### The Pull Request Process