From 4876ded68015448897479d187f5d23e8b8e398ae Mon Sep 17 00:00:00 2001 From: Chad Woolley Date: Mon, 10 Mar 2025 18:24:46 -0700 Subject: [PATCH 1/2] Update file README.md --- ee/lib/remote_development/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/ee/lib/remote_development/README.md b/ee/lib/remote_development/README.md index ae1c0714388e01..a8ed8848c79eb6 100644 --- a/ee/lib/remote_development/README.md +++ b/ee/lib/remote_development/README.md @@ -67,6 +67,7 @@ - [DeclarativePolicy guidelines](#declarativepolicy-guidelines) - [Testing DeclarativePolicy authorization policies](#testing-declarativepolicy-authorization-policies) - [Guidelines for writing tests using this pattern](#guidelines-for-writing-tests-using-this-pattern) +- [Coding standards for Remote Development bounded context](coding-standards-for-remote-development-bounded-context) - [FAQ](#faq) - [Why is the Result class in the top level lib directory?](#why-is-the-result-class-in-the-top-level-lib-directory) - [What are all the `noinspection` comments in the code?](#what-are-all-the-noinspection-comments-in-the-code) @@ -1294,6 +1295,23 @@ For available user roles, refer to: https://docs.gitlab.com/ee/user/permissions. end ``` +## Coding standards for Remote Development domain + +In addition to the patterns/etc. mentioned above, there are other coding standards which we wish to +enforce in the Remote Development domain / bounded context. + +Guidelines for these domain-specific standards: + +- They should not conflict with any standards in the wider codebase +- They may introduce additional standards which do not exist in the wider codebase +- They should be dicussed and have some level of consensus among the group's engineers, and the resulting + decision should be linked along with the standard in this section. +- They should ideally be enforced by linters, but if that is not possible/practical/easy, + they can start with just documentation in this section. + +Existing standards: + +1. Prefer double-quotes over single-quotes for delimiting String literals, even non-interpolated ones. [team decision](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124398#note_1444988985), [wider dicussion](https://gitlab.com/gitlab-org/gitlab/-/issues/198046) ## FAQ -- GitLab From 6e97613c8b1f8ab35317d5a0046a59220fd864e1 Mon Sep 17 00:00:00 2001 From: Chad Woolley Date: Wed, 12 Mar 2025 20:30:58 -0700 Subject: [PATCH 2/2] Apply 1 suggestion(s) to 1 file(s) --- ee/lib/remote_development/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ee/lib/remote_development/README.md b/ee/lib/remote_development/README.md index a8ed8848c79eb6..71f7b9eb0ef096 100644 --- a/ee/lib/remote_development/README.md +++ b/ee/lib/remote_development/README.md @@ -67,7 +67,7 @@ - [DeclarativePolicy guidelines](#declarativepolicy-guidelines) - [Testing DeclarativePolicy authorization policies](#testing-declarativepolicy-authorization-policies) - [Guidelines for writing tests using this pattern](#guidelines-for-writing-tests-using-this-pattern) -- [Coding standards for Remote Development bounded context](coding-standards-for-remote-development-bounded-context) +- [Coding standards for Remote Development domain](#coding-standards-for-remote-development-domain) - [FAQ](#faq) - [Why is the Result class in the top level lib directory?](#why-is-the-result-class-in-the-top-level-lib-directory) - [What are all the `noinspection` comments in the code?](#what-are-all-the-noinspection-comments-in-the-code) -- GitLab