patches and low-level development discussion
 help / color / mirror / code / Atom feed
From: Ville Ilvonen <ville.ilvonen@unikie.com>
To: Alyssa Ross <hi@alyssa.is>
Cc: devel@spectrum-os.org
Subject: Re: [PATCH] Documentation: Architecture Decision Record
Date: Wed, 13 Jul 2022 12:35:47 +0300	[thread overview]
Message-ID: <CAP-nJwGO6xS7+ELsdeN5BkxHY+PGaqXfe=RQKdQ6NdUxiJrr+g@mail.gmail.com> (raw)
In-Reply-To: <20220712181139.n5xun4gqs2izqxxo@eve>

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


  reply	other threads:[~2022-07-13  9:36 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-08 11:02 Ville Ilvonen
2022-07-12 18:11 ` Alyssa Ross
2022-07-13  9:35   ` Ville Ilvonen [this message]
2022-07-13  9:53     ` Alyssa Ross
2022-07-13 11:04       ` Ville Ilvonen
2022-07-22 11:32         ` Alyssa Ross
2022-07-22 11:37         ` Alyssa Ross
2022-07-13 10:04 ` Alyssa Ross
2023-01-03  7:03 ` Adam Joseph
2023-01-06 13:27   ` Alyssa Ross

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAP-nJwGO6xS7+ELsdeN5BkxHY+PGaqXfe=RQKdQ6NdUxiJrr+g@mail.gmail.com' \
    --to=ville.ilvonen@unikie.com \
    --cc=devel@spectrum-os.org \
    --cc=hi@alyssa.is \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://spectrum-os.org/git/crosvm
	https://spectrum-os.org/git/doc
	https://spectrum-os.org/git/mktuntap
	https://spectrum-os.org/git/nixpkgs
	https://spectrum-os.org/git/spectrum
	https://spectrum-os.org/git/ucspi-vsock
	https://spectrum-os.org/git/www

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).