Skip to content

Commit

Permalink
Uplift the contributions guide to include a reference to checking rea…
Browse files Browse the repository at this point in the history
…dme text and comments (#326)

Adding, to the contributions guide, a reference to the "Consider
comments and Readme text" principle (in the "Create knowledge" chapter)

(Also removed a couple of references to NHSD)

Co-authored-by: walteck <[email protected]>
  • Loading branch information
andyblundell and walteck authored Oct 1, 2024
1 parent 2302257 commit 9e98019
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thank you for your interest in improving the framework.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

The framework is concerned with engineering best practice at NHSD, however, operational matters (e.g. structure of teams, roles and responsibilities, etc.) are out of scope. Please consider this when adding new content, and if in doubt, any of the code owners will be more than happy to discuss.
The framework is concerned with engineering best practice, however, operational matters (e.g. structure of teams, roles and responsibilities, etc.) are out of scope. Please consider this when adding new content, and if in doubt, any of the code owners will be more than happy to discuss.

If you're new to Github and/or Markdown, Github's own [contributor's guide](https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md) provides good signposting on these topics.

Expand All @@ -25,4 +25,5 @@ When committing your changes, please reference the issue they're resolving, so i
* The framework is open to the world. This has a few implications:
* Nothing in it should be confidential, private to NHSE or include any personal data.
* All links in framework pages should be public.
* Consider comments and Readme text: comments in open source repos such as this are not official communications and don't go through the normal approval process for public communication. They can however still be interpreted as official communication, even if not intended as such. For further details please see ["Consider comments and Readme text" in "Create knowledge"](principles.md#3-create-knowledge)
* Use [inclusive language](inclusive-language.md): avoid terms which cause hurt and offence, including if they have historically been considered industry-standard terms.

0 comments on commit 9e98019

Please sign in to comment.