SSWConsulting / SSWConsulting/SSW.CleanArchitecture
✨ Publish a `ssw.adrs` dotnet new template
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 199
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
Cc: @danielmackay @william-liebenberg
Hi
Pain
I just had to setup ADRs in a project, and although it was fairly quick with a couple of copy and pastes... this process could have been better
Suggested Solution
Create a template that we can easily just run dotnet new ssw-adrs and get the basic layout with the first 2 ADRs (for markdown and log4brains) added and ready to go
Acceptance Criteria
Acceptance Criteria defines the requirements that must be met for the story to be completed. This is WHAT must be done.
See https://www.ssw.com.au/rules/acceptance-criteria.
- On a any project I can run
dotnet new ssw-adrsand commit with no additional changes
- Configure my GitHub pages configuration and everything just works
Tasks
Tasks help developers to track small bits of work needed to meet the ACs. This is HOW the work will be done.
- [ ] Create a new repository SSW.Templates.ADRs
- [ ] Add the base code needed to run the ADRs
- [ ] Publish a new nuget package which will install using the id `ssw-adrs`
- [ ] Done video
- [ ] Share to SSW Developers DL
More Information
Screenshots
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
No files or tests are named in the issue. Start with the dotnet new ssw-adrs entry point and review how the new repository and NuGet package should provide the two ADRs and GitHub Pages configuration. Done means the package installs, works in any project without additional changes, and the requested video and developer-community sharing are complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- cli, documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100