Re: [ELPA] propose to add vundo.el to ELPA

[Philip Kaludercic]

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