Skip to content

Commit f6775ae

Browse files
authored
updating guidance around comments and readme documents (#325)
1 parent f3abf7a commit f6775ae

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

principles.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ The following practices support the principle of building quality in.
100100

101101
**Record decisions.** Use the [Any Decision Record template](any-decision-record-template.md) to document point-in-time decisions providing information like context, assumption, drivers, options and rationale to articulate the decision for the stakeholders and your future self. Always, consider and compare options as a decision made without that is not a decision.
102102

103+
**Consider comments and Readme text** Comments in open source repos are not official communications and don't go through the normal approval process for public communication. They can however still be interpreted as NHSE communication, even if not intended as such, particularly for public repos. Especially when coding in the open, but also when developing in private repositories, consider the contents of Readme files and comments within the code. Ensure that comments add value to the code you are developing. Please avoid anything that could be considered a statement on approach/policy. Consider the broader impact of any text in these areas to ensure that the project and the organisation are reflected correctly. Note that we produce and maintain services that are important to the public, therefore it is essential to be careful and accurate when referring to these services. If in doubt please ask. Also note there is high sensitivity around protecting privacy so please be careful your comments reflect the importance and sensitivity around protecting personal data.
104+
103105
### 4. Defer commitment
104106

105107
**Make decisions small** by breaking a big problem down.

0 commit comments

Comments
 (0)