ENG-256: Agree indicative content of the CONTRIBUTING.md file #57

stefaniuk · 2023-05-17T06:23:24Z

Description

Fixes #5

Context

This change is to include guidance for contributors that will work on the codebase of a repository created from this template.

Type of changes

Refactoring (non-breaking change)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would change existing functionality)
Bug fix (non-breaking change which fixes an issue)

Checklist

I am familiar with the contributing guidelines
I have followed the code style of the project
I have added tests to cover my changes
I have updated the documentation accordingly
This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

timireland

Looks good

regularfry

We're doubling up a lot of information in here. It's probably duplication that's happened since this was written, but I suspect we're better off just with links to other places than duplicating it.

regularfry · 2023-10-18T12:25:40Z

docs/CONTRIBUTING.md

+  assertEquals(0, list.size());
+}
+```
+


Suggested change

Note that the `// Arrange`, `// Act`, and `// Assert` comments are not required. They are presented here to highlight the structure.

I've seen all sorts of projects where people seem to have got the idea that they need these comments in every test, might as well clarify it.

regularfry · 2023-10-18T12:28:40Z

docs/CONTRIBUTING.md

+}
+```
+
+### Code review


It might well not have done so when it was written, but this section seems to double up with https://github.com/NHSDigital/software-engineering-quality-framework/blob/340f9bfc64e4c8ac5ebcbc4d87d5fc2c76e37490/patterns/everything-as-code.md?plain=1#L43; we should only have this guidance in one place, really.

regularfry · 2023-10-18T12:30:36Z

docs/CONTRIBUTING.md

+
+### Pull Request
+
+- Set the title to `REF-XXX: Descriptive branch name`, where `REF-XXX` is the ticket reference number


Do we have a definitive board (Jira or otherwise) that we should be taking ticket references from? Do we need one?

regularfry · 2023-10-18T12:34:40Z

docs/CONTRIBUTING.md

+- Check file format ([EditorConfig](https://github.com/editorconfig))
+- Check markdown format ([markdownlint](https://github.com/DavidAnson/markdownlint))
+- Scan secrets ([GitLeaks](https://github.com/gitleaks/gitleaks))
+


Suggested change

- Check terraform format ([terraform](https://developer.hashicorp.com/terraform/cli/commands/fmt))

regularfry · 2023-10-18T12:37:56Z

docs/CONTRIBUTING.md

+✓ Logged in as your-github-handle
+```
+
+### Signing commits


We should remove this section in favour of the commit signing docs

regularfry · 2023-10-18T15:57:34Z

docs/CONTRIBUTING.md

+
+## Local environment
+
+### Prerequisites


I think this is now covered by the README.

regularfry · 2023-10-18T15:57:44Z

docs/CONTRIBUTING.md

+
+To ensure all the prerequisites are installed and configured correctly, please follow the [nhs-england-tools/dotfiles](https://github.com/nhs-england-tools/dotfiles) installation process.
+
+### Development environment configuration


As is this.

regularfry · 2023-10-18T15:59:00Z

docs/CONTRIBUTING.md

+
+## Git and GitHub
+
+### Configuration


This is covered in the dotfiles repository.

regularfry · 2023-10-18T15:59:38Z

docs/CONTRIBUTING.md

+
+More information on the git settings can be found in the [Git Reference documentation](https://git-scm.com/docs).
+
+### Authentication


Feels like this ought to be somewhere else, but I'm not sure where.

stefaniuk force-pushed the ENG-256_Agree_indicative_content_of_the_CONTRIBUTING_md_file branch from 46ec369 to 7f08a16 Compare May 31, 2023 11:16

stefaniuk changed the title ~~WIP: ENG-256: Agree indicative content of the CONTRIBUTING.md file~~ ENG-256: Agree indicative content of the CONTRIBUTING.md file May 31, 2023

stefaniuk requested a review from timireland June 1, 2023 14:39

stefaniuk force-pushed the ENG-256_Agree_indicative_content_of_the_CONTRIBUTING_md_file branch from caebd11 to a6c231e Compare June 7, 2023 11:44

timireland approved these changes Jun 8, 2023

View reviewed changes

stefaniuk force-pushed the ENG-256_Agree_indicative_content_of_the_CONTRIBUTING_md_file branch 2 times, most recently from ad42cda to e61dd2c Compare July 2, 2023 19:10

stefaniuk mentioned this pull request Jul 4, 2023

Add a note about the pre-commit framework to the CONTRIBUTING.md documentation #83

Closed

stefaniuk force-pushed the ENG-256_Agree_indicative_content_of_the_CONTRIBUTING_md_file branch 2 times, most recently from 60eaff4 to 02f6e8c Compare July 18, 2023 18:58

stefaniuk force-pushed the ENG-256_Agree_indicative_content_of_the_CONTRIBUTING_md_file branch from 02f6e8c to 35bb407 Compare July 31, 2023 14:17

regularfry requested changes Oct 18, 2023

View reviewed changes

stefaniuk added 5 commits November 25, 2023 08:17

Add CONTRIBUTING.md file

ebdec1d

Improve content of the documentation

3528a64

Update documentation

dfc3adb

Typo

48bebfe

Update documentation

3c78864

stefaniuk force-pushed the ENG-256_Agree_indicative_content_of_the_CONTRIBUTING_md_file branch from 35bb407 to 3c78864 Compare November 25, 2023 08:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENG-256: Agree indicative content of the CONTRIBUTING.md file #57

ENG-256: Agree indicative content of the CONTRIBUTING.md file #57

stefaniuk commented May 17, 2023 •

edited

Loading

timireland left a comment

regularfry left a comment

regularfry Oct 18, 2023

regularfry Oct 18, 2023

regularfry Oct 18, 2023

regularfry Oct 18, 2023

regularfry Oct 18, 2023

regularfry Oct 18, 2023

regularfry Oct 18, 2023

regularfry Oct 18, 2023

regularfry Oct 18, 2023



	Note that the `// Arrange`, `// Act`, and `// Assert` comments are not required. They are presented here to highlight the structure.


		### Pull Request

		- Set the title to `REF-XXX: Descriptive branch name`, where `REF-XXX` is the ticket reference number


	- Check terraform format ([terraform](https://developer.hashicorp.com/terraform/cli/commands/fmt))


		To ensure all the prerequisites are installed and configured correctly, please follow the [nhs-england-tools/dotfiles](https://github.com/nhs-england-tools/dotfiles) installation process.

		### Development environment configuration


		More information on the git settings can be found in the [Git Reference documentation](https://git-scm.com/docs).

		### Authentication

ENG-256: Agree indicative content of the CONTRIBUTING.md file #57

Are you sure you want to change the base?

ENG-256: Agree indicative content of the CONTRIBUTING.md file #57

Conversation

stefaniuk commented May 17, 2023 • edited Loading

Description

Context

Type of changes

Checklist

Sensitive Information Declaration

timireland left a comment

Choose a reason for hiding this comment

regularfry left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stefaniuk commented May 17, 2023 •

edited

Loading