Adopt the John Papa Style Guide for AngularJS
Summary
=======
Horizon should use the the John Papa Style Guide as the primary point of reference
for angular code style. This style guide has been endorsed by the AngularJS
team with the following statement "The most current and detailed Angular Style
Guide is the community-driven effort led by John Papa and Todd Motto."
Motivation
========
We need a consistent set of rules to enforce code style accepted into horizon. After two releases of real angular effort,we have not developed a quality code style guide of our own. It is best to adopt one recommended by the industry.
Description
=========
The style guide is found here:
https:/
When reviewing / writing good, please refer to the sections of this guide.
If an issue is encountered, note it with a comment and provide a link back
to the specific issue. For example, code that has implementation details prior
declared members should be marked with a pointer to:
https:/
We will
1) Document it
2) Refactor existing code appropriately
3) Add style tests.
UX
===
There shouldn't be any major UX impact.
Testing
======
We need to bring in as much automated testing as possible. Probably start with the below:
JSCS: https:/
Linter: https:/
Outside Dependencies
==================
ESLint (if used)
Requirements Update Required
=======
None at the moment.
Doc Impact
=========
Will update the contributing.rst file in docs.
Blueprint information
- Status:
- Complete
- Approver:
- David Lyle
- Priority:
- Low
- Drafter:
- Travis Tripp
- Direction:
- Approved
- Assignee:
- Travis Tripp
- Definition:
- Approved
- Series goal:
- Accepted for liberty
- Implementation:
- Implemented
- Milestone target:
- 8.0.0
- Started by
- Travis Tripp
- Completed by
- David Lyle
Related branches
Related bugs
Sprints
Whiteboard
Gerrit topic: https:/
Addressed by: https:/
Adopt the John Papa Style Guide for AngularJS
Addressed by: https:/
Use the JP Style Guide for KeyStone Service
Addressed by: https:/
Use the JP Style Guide for Nova Service
Addressed by: https:/
Use the JP Style Guide for OpenStack Services