From: Philip Kaludercic <philipk@posteo.net>
To: Yuan Fu <casouri@gmail.com>
Cc: Emacs developers <emacs-devel@gnu.org>
Subject: Re: [ELPA] propose to add vundo.el to ELPA
Date: Wed, 06 Apr 2022 18:35:20 +0000 [thread overview]
Message-ID: <87k0c2rrfb.fsf@posteo.net> (raw)
In-Reply-To: <489553CD-96EC-489C-9445-6147BBD1D63F@gmail.com> (Yuan Fu's message of "Wed, 6 Apr 2022 10:52:37 -0700")
Yuan Fu <casouri@gmail.com> writes:
>>>
>>> diff --git a/elpa-packages b/elpa-packages
>>> index e218968e87..8fb17c4baf 100644
>>> --- a/elpa-packages
>>> +++ b/elpa-packages
>>> @@ -630,6 +630,12 @@
>>> ("vertico-posframe"
>>> :url "https://github.com/tumashu/vertico-posframe"
>>> :auto-sync t)
>>> + ("vundo"
>>> + :url "https://github.com/casouri/vundo"
>>> + :ignored-files ("test")
>>> + :doc "README.txt"
>> ^
>> I am assuming this is supposed to be a :readme, not a :doc.
>> Or do you actually want to create a manual out of the README?
>
> That should be README.
Ok.
>> As your commentary section seems to intentionally mirror the
>> README (if this is the right thing is a different question. I
>> don't know why a package.el user is interested in testing if the
>> testing code isn't bundled in the package), this could just be
>> dropped.
>
> Should I let ELPA ignore README.txt and only use Commentary then?
Sure that can be done. I personally like this approach because a README
in my eyes is what a contributor is interested in while the commentary
section is what a package user wants to know.
>>
>>> + :news "NEWS.txt"
>>
>> I see that your README also contains a news section. It might make
>> sense only maintain the news in one of the two, to avoid duplication on
>> elpa.gnu.org.
>>
>> Besides that, it seems to be that the introduction in README.txt doesn't
>> immediately explain what the package is about. This might confuse
>> people using C-h P to preview the package before installing it.
>
> Thanks. I fixed those points and here is the new patch. In this patch
> I removed README.txt. If it turns out to be not desirable, I can make
> another patch.
Looks good. BTW, you can also add a .elpaignore file to your repository
if you want to maintain what files to ignore on your end.
--
Philip Kaludercic
next prev parent reply other threads:[~2022-04-06 18:35 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-04 20:51 [ELPA] propose to add vundo.el to ELPA Yuan Fu
2022-04-05 3:41 ` Michael Heerdegen
2022-04-06 4:20 ` Yuan Fu
2022-04-07 22:58 ` Michael Heerdegen
2022-04-08 0:43 ` Yuan Fu
2022-04-10 1:23 ` Michael Heerdegen
2022-04-05 7:23 ` Philip Kaludercic
2022-04-06 4:23 ` Yuan Fu
2022-04-06 10:13 ` Philip Kaludercic
2022-04-06 17:52 ` Yuan Fu
2022-04-06 18:08 ` Yuan Fu
2022-04-06 18:10 ` Yuan Fu
2022-04-06 18:35 ` Philip Kaludercic [this message]
2022-04-15 14:25 ` Philip Kaludercic
2022-04-06 12:24 ` Stefan Monnier
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=87k0c2rrfb.fsf@posteo.net \
--to=philipk@posteo.net \
--cc=casouri@gmail.com \
--cc=emacs-devel@gnu.org \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.