search

navapbc / template-infra

A template to set up foundational infrastructure for your application in AWS
Apache License 2.0
9 stars 2 forks source link

Use Date Instead of Number for ADR File Names #401

Open acouch opened 1 year ago

acouch commented 1 year ago

Using a date format for ADRs, instead of a number, makes it easier to work on multiple ADRs at once and makes it easier to adopt ADRs associated with the templates in a new project as the dates can stay the same and the filenames don't need to be updated.

This came up on grants.gov, where YYYY-MM-DD-descrption.md has been adopted: https://github.com/HHS/grants-equity/tree/main/documentation/decisions

rocketnova commented 1 year ago

+1 We ran into something like this on BDS and had a whole conversation about how to deal with number conflicts (though we didn't resolve it).

Does the YYYY-MM-DD-description.md filename format work with adr-log?

acouch commented 1 year ago

Does the YYYY-MM-DD-description.md filename format work with adr-log?

Yes. The entries in the index become [ADR-YYYY-MM-DD](YYYY-MM-DD-description.md) - Description.