SSW.CleanArchitecture icon indicating copy to clipboard operation
SSW.CleanArchitecture copied to clipboard

🐛 The ADR template should use the standard for replaceable text placeholders

Open GordonBeeming opened this issue 1 year ago • 3 comments

Cc: @jernejk

Hi

Describe the Bug

As per Do you use the right character for replaceable text placeholders?, we should update the placeholders in the ADR template to use {{ PLACEHOLDER }}

To Reproduce

Steps to reproduce the behavior:

  1. Go to https://github.com/SSWConsulting/SSW.CleanArchitecture/blob/main/docs/adr/template.md?plain=1
  2. Observe the placeholders use [ placeholders ]

Expected Behavior

Placeholders should be in the format {{ PLACEHOLDER }}

Tasks

  • [ ] Update placeholders

Thanks!

GordonBeeming avatar Oct 27 '23 06:10 GordonBeeming

@danielmackay, are you happy that I look at replacing these placeholders?

GordonBeeming avatar Oct 27 '23 06:10 GordonBeeming

@danielmackay, are you happy that I look at replacing these placeholders?

@GordonBeeming - yes I'm happy for you to do that. Thanks for the suggestion. 😄

danielmackay avatar Oct 27 '23 07:10 danielmackay

I have created a PR for this but it might not pass due to insufficient permissions. https://github.com/SSWConsulting/SSW.CleanArchitecture/pull/190

UPDATE: The PR can't be merged because of the https://github.com/SSWConsulting/SSW.CleanArchitecture/issues/191 bug.

jernejk avatar Oct 27 '23 07:10 jernejk