search

NHSDigital / software-engineering-quality-framework

🏎️ Shared best-practice guidance & tools to support software engineering teams
147 stars 35 forks source link

Add worked examples for code repository commit signing #273

Closed patrickmoore-nc closed 2 years ago

patrickmoore-nc commented 2 years ago

Signing commits can be quite tricky. Providing clear worked examples can reduce inertia to set this up. Furthermore the reasons for enforcing signing are not well understood, even among developers.

Some of these patterns have been built in the CCOE, so sharing them here in a generic way can facilitate adoption of these quality standards.

stefaniuk commented 2 years ago

That's a very good suggestion @patrickmoore-nc

We have some guidelines and working examples/scripts. One of them is located here https://github.com/nhsd-exeter/make-devops/blob/main/documentation/Contributing.md#signing-your-git-commits

Is this the level of detail that we would like to see in the framework?

stefaniuk commented 2 years ago

👍 I'm just looking at your PR.

patrickmoore-nc commented 2 years ago

Does the markdown pass validation now?

stefaniuk commented 2 years ago

There are about a dozen linting warnings coming from the nhsd-git-secrets/README.md file. Would you mind having a look, please?

The way the liner works is that it validates the whole file that has been changed as part of the PR. These issues may have been created in the past by someone else. I suspect this is the case - not your changes. However, our intention is to fix these as we go. Hope you are ok with that?

stefaniuk commented 2 years ago

PR #274 merged