Coding style compliance checker

Registered by Joshua Harlow

Nova has a tool for checking HACKING compliance. It would be good to have this in openstack-common so that other projects can use it.

One issue is that projects may have slight differences in coding style and HACKING guidelines. Do we have all projects adopt the same guidelines or allow the tool be configured?

Blueprint information

Status:
Complete
Approver:
Mark McLoughlin
Priority:
Low
Drafter:
Mark McLoughlin
Direction:
Approved
Assignee:
None
Definition:
Approved
Series goal:
None
Implementation:
Implemented
Milestone target:
None
Started by
Doug Hellmann
Completed by
Doug Hellmann

Related branches

Sprints

Whiteboard

I have been working on something like this as part of nova (see nova/tools/hacking.py). It checks for HACKING.py compliance (including import style) ~jogo

Any volunteers to move jogo's work into openstack-common?

not all projects have the same HACKING guidelines, making moving HACKING.py into oslo a challenge. ~jogo 11/6/2012

I think there's relatively small differences between projects, I'm hoping it's manageable

FWIW, I don't see why project's need their own, subtly different guidelines ~markmc

"one place that nova differs is in https://github.com/openstack/nova/blob/master/HACKING.rst#imports" ~jogo 12/4/2012

I think this is started under the hacking project. Do we still need the blueprint? - dhellmann 15 Nov 2013

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.