Re: re-formatting CREDITS file
| From: | Pierre Joye | Date: | Sun, 07 Jun 2009 21:42:24 +0000 |
| Subject: | Re: re-formatting CREDITS file | ||
| References: | 1 | Groups: | php.pecl.dev |
| Request: | Send a blank email to pecl-dev+get-6459@lists.php.net to get a copy of this message | ||
hi Greg,
On Fri, Jun 5, 2009 at 10:27 PM, Greg Beaver<greg@chiaraquartet.net> wrote:
> I'm currently working on some of the last steps in the next-generation
> PEAR installer, Pyrus, and have a few questions for PECL.
>
> One of the significant upgrades available with Pyrus is the pickle
> command now will generate a package.xml from scratch and make a release
> (the package command is still available for those who prefer to manage
> package.xml by hand).
I don't think there is anyone around preferring that :)
I really like this concept, it is much more developer friendly than
what we have now. Great job.
> The pickle command relies upon a few files to do its magic, such as
>
> README
> CREDITS
> RELEASE-X.Y.Z
Does it support text formatting like markdown or rest? that would even better.
> However, the current format of the CREDITS file only contains names.
> Would it be possible for people to standardize the format of this file?
> The best would be:
The format describes below is fine from an information point of view.
One thing to keep in mind is that this file is used to generate the
Credits page in phpinfo() which should contain only names (I don't
think we should clutter it with all these details). It should be easy
to update the generation script to support this new format (script is
in php-src).
> Full Name [handle] <email@example.com> (role)
> The README file should contain summary as first line, description as the
> rest of the file, and RELEASE-X.Y.Z should contain the release notes
> (and X.Y.Z should be the version, pickle uses the newest version).
Same comment as before, I would love to be able to use a marker format
in these files. It can then be used to generate information page about
a release/package/etc. in a nice way (be html, pdf, etc.).
Cheers,
--
Pierre
http://blog.thepimp.net | http://www.libgd.org