Open thomvaill opened 3 years ago
What's the status of this?
I personally think that "decisions" is more immediately understandable than "adr".
I agree too. I'll make the change in the next version. Or if someone wants to contribute, PRs are welcome :-)
Should log4brains adr new
have an alias for log4brains decision new
?
I just tried implementing this, there are over 2200 mentions of ADR in the repo, some of them are non-obvious to replace, for the time being I renamed my folder and changed the adrFolder
as the project is configurable.
One minor but eventually "bike sheddable" discussion is singular vs plural, the project is consistent right now with all singular, by having docs/decisions
and log4brains decision new
, thing could get confusing, maybe a command alias would be welcomed in this case.
I've taken a stab at updating this in #98. Please feel free to provide feedback.
@tylerhubert Looks great!
Feature Request
Feature Suggestion
For now, the default directory for ADRs is
docs/adr
, because it was commonly documented like this:But @joelparkerhenderson recently gave me this interesting feedback:
So I propose to change the default value in Log4brains, because I am convinced that ADRs should not be reserved only for important architectural decisions. They are also beneficial for all kind of decisions, and we should promote that.
Possible Implementation
docs/adr
in the READMEdocs/adr
in the code, only when it is used as a default value