git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Patrick Steinhardt <ps@pks.im>
To: Abraham Samuel <sammymore50@gmail.com>
Cc: git@vger.kernel.org, phillip.wood@dunelm.org.uk,
	"gitster@pobox.com" <gitster@pobox.com>
Subject: Re: [Outreachy][RFC]: teach the '-e' option for git notes sub command
Date: Thu, 17 Oct 2024 14:07:53 +0200	[thread overview]
Message-ID: <ZxD-FCW9drBpC4c5@pks.im> (raw)
In-Reply-To: <CAO1n886ZRRD6m_GQsYz-AGwpbkDB4S+0+hRx-9mmN=6iJ1o7Mg@mail.gmail.com>

On Thu, Oct 17, 2024 at 10:43:56AM +0100, Abraham Samuel wrote:
> Hello,
> 
> I was searching through the list for a #leftoverbits project that I could do.
> I then came across this conversation
> 
> https://public-inbox.org/git/xmqqed7bhobk.fsf@gitster.g/.
> 
> The suggestion was made to make messages seeded with -m/-F to the "git
> notes add" subcommand be editable when the "-e" option is passed to
> it. This allows modifying the message by opening the default editor to
> enable the message to be edited before adding the note.
> 
> I have checked the current version of git and there is no "-e" option
> implemented.
> I am also studying similar implementations for git commit and git tag
> to help me understand the implementation.
> However, I would like to know if I am permitted to go ahead and if
> yes, I would appreciate pointers to other resources to aid me in
> implementing it.

You don't have to ask for permission in order to fix issues. So please,
feel free to go ahead.

I assume you've already read through the common documents that we have
in Documentation/, like MyFirstContribution.txt et al. Other than that
I'd recommend to have a look at how this is implemented in preexisting
commands, but you already had that idea yourself. You could also dig
into the history of how those `-e` options have been introduced for
these commands, which might give you an idea what was required to be
done for them, and you'll likely have to do something similar for `git
notes add`.

I don't really think we have any other resources that would be helpful
in this context.

Patrick

  reply	other threads:[~2024-10-17 12:07 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-17  9:43 [Outreachy][RFC]: teach the '-e' option for git notes sub command Abraham Samuel
2024-10-17 12:07 ` Patrick Steinhardt [this message]
2024-10-19  9:13   ` Abraham Samuel

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=ZxD-FCW9drBpC4c5@pks.im \
    --to=ps@pks.im \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=phillip.wood@dunelm.org.uk \
    --cc=sammymore50@gmail.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 NNTP newsgroup(s).