Re: [PATCH] Documentation: Architecture Decision Record

Ville Ilvonen
2022-07-13T09:36:05Z

On Tue, Jul 12, 2022 at 9:11 PM Alyssa Ross <hi@alyssa.is> wrote:
>
> On Fri, Jul 08, 2022 at 02:02:15PM +0300, Ville Ilvonen wrote:
> > * ADRs based on discussions with Alyssa
> > * A note on ADRs to architecture.adoc
> >
> > Signed-off-by: Ville Ilvonen <ville.ilvonen@unikie.com>
>
> Hi Ville, thanks for taking the lead on these.
>
> I've been wondering whether it would be better to only take accepted
> ADRs into the Spectrum repository, and leave proposed ones for
> discussion on the list until they're ready to be accepted. I think that
> would make the distinction between them clearer. What do you think?

I was thinking separation by status when writing the PR.
Maybe restructuring to folders like
Documentation/adr/accepted
Documentation/adr/proposed
...
would make sense?

> In future, it would probably also be good for each ADR to be its own
> commit, to make them easier to discuss one at a time. (I will add this
> to the documentation around submitting patches, when I get a chance to
> write it.)

Agreed.

> Finally, all the files being added need license and copyright headers.
> I'd suggest using the same license as the rest of the documentation.

Sure, this came to my mind right after I had sent the PR but I decided to wait
for your review comments before fixing this.

> I'm happy to include at least the accepted ADRs, if the proper headers
> are included. You can check all required headers are present by running
> `reuse lint` in the Spectrum repository.

Thanks.

Best, -Ville