public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Guinevere Larsen <blarsen@redhat.com>
To: Simon Marchi <simon.marchi@efficios.com>, gdb-patches@sourceware.org
Cc: binutils@sourceware.org
Subject: Re: [PATCH] gdb: add .pre-commit-config.yaml
Date: Tue, 12 Mar 2024 11:50:22 +0100	[thread overview]
Message-ID: <113f5f06-680f-415a-bbff-117ff71afaf7@redhat.com> (raw)
In-Reply-To: <20240311150947.71762-1-simon.marchi@efficios.com>

I have no real opinion on pre-commit, one way or another, but I like the 
idea of automating easily-forgotten things. could even be upgraded to 
rerunning gdbarch.py at some point!

On 11/03/2024 16:09, Simon Marchi wrote:
> I will add these instructions to the wiki if this patch gets merged, so
> they are easy to find.  We could perhaps think of having a
> gdb/CONTRIBUTING document of some sort checked in the repo with that
> kind of information.

I have positive opinions on this, however! I don't find the contribution 
checklist on the wiki to be a good description of the contribution 
process of GDB. I'm not sure what I know from there and what is 
essential tribal knowledge that I got from internal talks and incorrect 
submissions that were corrected. The maintainers file is the closest we 
have to describing the process, and someone who doesn't know the project 
would not think of looking there, I don't think (I know I didn't).

So I would be very happy to see a contributing file, where the process 
as a whole is described in order, before going down to the minutiae of 
how to make a good contribution. One and done things like pre-commit, 
choosing a way to send email, copyright attribution, can be easily 
viewed by prospecting contributors, and previous contributors can 
refresh their minds or quickly check some recent process change.

-- 
Cheers,
Guinevere Larsen
She/Her/Hers


  parent reply	other threads:[~2024-03-12 10:50 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-11 15:09 Simon Marchi
2024-03-11 20:26 ` Tom Tromey
2024-03-12 10:50 ` Guinevere Larsen [this message]
2024-03-20 13:44 ` Andrew Burgess
2024-03-20 15:56   ` Simon Marchi

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=113f5f06-680f-415a-bbff-117ff71afaf7@redhat.com \
    --to=blarsen@redhat.com \
    --cc=binutils@sourceware.org \
    --cc=gdb-patches@sourceware.org \
    --cc=simon.marchi@efficios.com \
    /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.
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 read-only IMAP folder(s) and NNTP newsgroup(s).