tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-06-28 23:49:26 +02:00
Code Issues Projects Releases Wiki Activity

DOC RFC-8996 clarify public APIs

Browse Source
This commit is contained in:
Serge Latyntcev 2019-10-22 10:51:33 +13:00
parent 33a28394d6
commit c5cd54e5d8
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/en/05_Contributing/01_Code.md
View File

@ -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