Community mailing list archives

community@mail.odoo.com

Re: README.md files of OCA projects

by
Camptocamp France SAS, Alexandre Fayolle - Camptocamp
- 09/18/2014 02:31:52
On 17/09/2014 16:04, Leonardo "LeartS" Donelli wrote:
> Hi all,
> Recently I've been looking for a module and the various OCA
> repositories README files are not that helpful. Most of the times it's
> just something along the lines of:
>
> > Repo name: account-payment
> > README.md: This project includes modules that handle payment related tasks.
>
> > Repo name: manufacture
> > README.md: Odoo modules related to Manufacturing
>
> Not really helpful, so I had to look at the __openerp__.py files of
> all the modules in there.
> I think it would be nice and a good way to improve the OCA projects to
> extend the repositories README to include:
>  * A full description of what kind of modules are in that repo, not
> just "manufacturing related modules
>  * An updated list of modules in that repo, with each voice indicating
> the modue name, technical name, and a rough overview of the module
> purpose, with a link to the specific module README if it exists (now
> that is possibile to use README files as __openerp__.py module
> descriptions!) which should be a lot more detailed and include
> possible problems, TODO, how to use and so on.
>
> Or it could even be considered to start using the repositories github
> wikis which I've seen are enabled.
>
> What do you think?
>
> _______________________________________________
> Mailing-List: https://www.odoo.com/groups/community-59
> Post to: mailto:community@mail.odoo.com
> Unsubscribe: https://www.odoo.com/groups?unsubscribe
>
Hi Leonardo,

For the record, in lots of cases, the README.md was created from the
existing short description available in the launchpad project page,
which was not much, and there is certainly much room for improvement.

So please follow the usual process: fork the repositories, and submit PR
improving the README.md files. Any PR improving the descriptions in
__openerp__.py is welcome too.

-- 
Alexandre Fayolle
Chef de Projet
Tel : + 33 (0)4 79 26 57 94

Camptocamp France SAS
Savoie Technolac, BP 352
73377 Le Bourget du Lac Cedex
http://www.camptocamp.com