File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -50,6 +50,23 @@ messages:
5050- ` feat ` : bump minor version number
5151- ` BREAKING CHANGE ` : bump major version number
5252
53+ ## Documentation
54+
55+ ### Architecture Decision Records (ADRs)
56+
57+ This project is configured to use [ Nat Pryce's] ( https://github.com/npryce )
58+ [ adr-tools] ( https://github.com/npryce/adr-tools ) project. There is a template
59+ at ` doc/adrs/templates/template.md ` which can be edited at-will. The ADR
60+ template is built to support both human and machine (AI/LLM)-produced and
61+ maintained ADRs. The configuration file, ` .adr-dir ` resides at the root of
62+ the project and may be updated if ADRs are to be stored in an alternate
63+ directory.
64+
65+ For more information about ADRs, check out
66+ [ Michael Nygard] ( https://cognitect.com/authors/MichaelNygard.html ) 's
67+ [ article] ( https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions )
68+ on the topic.
69+
5370## License
5471
5572This project is licensed under the Creative Commons License 1.0 Universal
Original file line number Diff line number Diff line change 22 "version" : " 0.2" ,
33 "language" : " en" ,
44 "words" : [
5+ " ADR" ,
6+ " ADRs" ,
57 " Certbot" ,
68 " certbot" ,
79 " kiprox" ,
810 " SSTP" ,
911 " Mikrotik" ,
12+ " Pryce" ,
1013 " RouterOS" ,
1114 " letsencrypt" ,
1215 " privkey" ,
You can’t perform that action at this time.
0 commit comments