SSWConsulting / SSWConsulting/SSW.CleanArchitecture
🐛 The ADR template should use the standard for replaceable text placeholders
Open
Nobody has claimed this yet.
Type: Bug
- Dominant language
- C#
- Stars
- 199
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
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:
- Go to https://github.com/SSWConsulting/SSW.CleanArchitecture/blob/main/docs/adr/template.md?plain=1
- Observe the placeholders use [ placeholders ]
Expected Behavior
Placeholders should be in the format {{ PLACEHOLDER }}
Tasks
- Update placeholders
Thanks!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open docs/adr/template.md and inspect the existing bracketed placeholders. Update the placeholders to the {{ PLACEHOLDER }} format described in the issue; done means the ADR template no longer uses [ placeholders ].
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100