diff --git a/docs/CODING_STANDARDS.md b/docs/CODING_STANDARDS.md index 6a6eea2d..4f935434 100644 --- a/docs/CODING_STANDARDS.md +++ b/docs/CODING_STANDARDS.md @@ -695,6 +695,17 @@ API Documentation All classes and public API should be documented using [JSDuck annotations](https://github.com/senchalabs/jsduck). +Branch Naming +------------- + +We follow the uni-repo approach so our source is in one place. To work around some of the issues - for example looking at all PRs affecting a certain service - we prefix branches with the name of the service(s) the branch affects. + + PR branch names, e.g. “api-”, “ide-”, “multi-ide-vfs-sapi-”. + +Checking for branch naming consistency is part of the review process and the teams responsibility. + + Use “all-” in case of doubt. E.g., https://github.com/c9/newclient/pull/12962/files affects redis schema code. + Other Resources ===============