Contributors mailing list archives

contributors@odoo-community.org

Re: OCA Coding Standards and recommended IDEs

by
Ecosoft, Kitti Upariphutthiphong
- 16/10/2015 18:23:10
Thanks for open up this thread.

I support the idea to have the section getting started with IDE. Not to force to use any particular IDE, but to help people understand how to use pep8, pylint, flake8 etc. for the IDE of choice.

(I still confused what are the difference, any why we need all of them)

I personally had hard time to understand how to get my starting contribution to pass all the test (especially the formatting one) in Travis CI. 

Tips with particular will be IDE will be cool. I am using PyDev, but also trying to use Sublime as it seem to be famous around. Still, couldn't figure out how to use it efficiently for Odoo / Python. I would be nice to know how other people use it.

But I think it would benefit and accelerate many people who want to be part of OCA.

Kitti U.

On Fri, Oct 16, 2015 at 9:08 PM, Daniel Reis <dgreis@sapo.pt> wrote:
> I think we are actually saying the same thing: what Travis does, is a
> somewhat custom setup of flake8 + pylint.
>
> What we need is a simple standalone wrapper, independent of everything
> (especially Travis) that does just the same check that Travis does
> now.
>
> Then:
> - travis just runs the script
> - people can run the script locally from the command line
> - optional: people can configure their editor of choice to run it
> inside the editor. This is something I am actually confortable giving
> specific advice about (example "if you use vim you can configure
> syntastic to run the checker XXX on python files")
>
> Of course I agree with Oleg: we want to easily run the same checks
> that Travis runs locally.

Agreed, contributions welcome:
https://github.com/OCA/maintainer-quality-tools/issues/281

Additionally, I suggest:
-The CONTRIBUTING.md file is missing from most repos, we should fix that
- The document it points at, OCA/maintainer-tools/CONTRIBUTING.md", 
should be a "getting started" text instead of the actual coding standards.

/DR

_______________________________________________
Mailing-List: http://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: http://odoo-community.org/groups?unsubscribe




--
Mobile: +66-(0)8-1841-7480
Your ERP Partner => www.ecosoft.co.th