Contributors mailing list archives


Re: OCA Coding Standards and recommended IDEs

- 16/10/2015 19:44:52
I reopen
to solve the style questions once and for all in out short lives! :D

El vie., 16 oct. 2015 a las 13:41, David Arnold (<>) escribió:

it seems that the lemma "improve default, but swapable" is getting ever more popular and is frequently requested by "outsiders" (read: potential insiders). So I think, it serves best the goals of the OCA to give the vote to those "potentials".

Hands on!

I have started a wiki stub according to Daniels suggestion, which you can find here:

Here is the corresponding discussion about Staging tooling.
Please feel free to help me improve the wiki page and contribute to the discussion about the staging tooling.

Once the wiki page is in version 1.0 we have something real to vote/opinion on. If people like it, we leave it. If people hate it, we take it down. It can be as simple as that, IMHO. :)

Thanks for joining in getting your hands dirty.

Best David

El vie., 16 oct. 2015 a las 13:23, <> escribió:
I also agree that there shouldn't be any recommended tool in OCA, but only a host for facilities, plugins and so on for all the possible tools that community can contribute. That host can be another GitHub repo called ide-tools. If you agree, please make the proposal to This way, people can choose their favourite IDE, and then see if other people has develop some commodities for it.

About running quality tools locally, there's already some work I made for integrating this on the git flow as a pre-condition for allowing to make commits (this is called pre-commit on git nomenclature). You can see it here: This is the logical and more uniform way, because independent from the chosen IDE, you must pass through git for working with OCA. This tool can be also be run in command line invoking pre-commit script. There's a pending PR from Moisés that updates this script to be up to date with latest changes in MQT:, but it needs to be fixed.


2015-10-16 16:08 GMT+02:00 Daniel Reis <>:
> 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:

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


Post to:

Post to: