tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #9299 from open-sausages/pulls/4/rfc-8996

Browse Source 
DOC RFC-8996 clarify public APIs
This commit is contained in:
Robbie Averill 2019-12-13 18:02:55 -08:00 committed by GitHub
commit 9fb4c75393
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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

@ -96,6 +96,21 @@ As we follow SemVer, we name the branches in repositories accordingly
- `<positive digit> "." <digits>` branches contain released minor versions and all changes for yet to be released patch versions
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