openstack/horizon
Code Issues Proposed changes
f2a9bb6eae
horizon/HACKING.rst

16 lines
569 B
ReStructuredText
Raw Normal View History

Make HACKING.rst formatting sync with other repos Make HACKING.rst have the same format as in other OpenStack repos. When working across multiple projects its nicer to have files have the same formatting to reduce confusion. Change-Id: I078f7ba512cfd8ccaf646e37287bcdbb11e54e90
2013-11-11 10:46:57 -08:00
Horizon Style Commandments
==========================
Add HACKING.rst Add HACKING.rst but instead of copying the file around point to the new cannonical location for it https://github.com/openstack-dev/hacking/blob/master/HACKING.rst Also expand out the flake8 H series ignores, so they can be enabled one by one. Change-Id: I6ec39d00c3beabbc3e661754bac6e43a0fb351d6
2013-06-07 16:57:49 -07:00
Make HACKING.rst formatting sync with other repos Make HACKING.rst have the same format as in other OpenStack repos. When working across multiple projects its nicer to have files have the same formatting to reduce confusion. Change-Id: I078f7ba512cfd8ccaf646e37287bcdbb11e54e90
2013-11-11 10:46:57 -08:00
- Step 1: Read the OpenStack Style Commandments
Updates OpenStack Style Commandments link The current links in the HACKING file are broken. This references the correct location for contributors to view. Change-Id: I785ae8e01a7e88f7bc3b94c59ea0c35068fede13
2013-10-16 16:15:07 +05:30
http://docs.openstack.org/developer/hacking/
Remove #noqa from django.conf.urls.include We have one more import with #noqa: django.conf.urls.include that is also commonly used in urls.py module and could be included to the list of import exceptions. This change has also revealed one unused import. Change-Id: I47cc582340625aac87ab0242b147e11ef1d9b38e
2014-09-25 16:13:02 +04:00
- Step 2: Read [hacking] section in tox.ini to find the list of names which
can be imported directly without triggering the "H302: import only modules"
flake8 warning
Remove #noqa from most common imports and add them to import_exceptions We have a lot of import with #noqa that is there to ignore h302, because it's traditional to import and use a name directly, instead of a whole module. This hides other errors and gives people the impression that it's actually fine to import non-modules, you just have to slap #noqa on those lines. I went through the code and identified about a dozen names that are most commonly imported this way. I remove the #noqa tag from them, and added them to the list in import_exceptions. I also removed a few unused imports that were revealed in the process. Change-Id: I27afb8e2b1d4759ec974ded9464d8f010312ee78
2014-01-03 17:31:49 +01:00
- Step 3: Read on
Add HACKING.rst Add HACKING.rst but instead of copying the file around point to the new cannonical location for it https://github.com/openstack-dev/hacking/blob/master/HACKING.rst Also expand out the flake8 H series ignores, so they can be enabled one by one. Change-Id: I6ec39d00c3beabbc3e661754bac6e43a0fb351d6
2013-06-07 16:57:49 -07:00
Make HACKING.rst formatting sync with other repos Make HACKING.rst have the same format as in other OpenStack repos. When working across multiple projects its nicer to have files have the same formatting to reduce confusion. Change-Id: I078f7ba512cfd8ccaf646e37287bcdbb11e54e90
2013-11-11 10:46:57 -08:00
Horizon Specific Commandments
-----------------------------
Add HACKING.rst Add HACKING.rst but instead of copying the file around point to the new cannonical location for it https://github.com/openstack-dev/hacking/blob/master/HACKING.rst Also expand out the flake8 H series ignores, so they can be enabled one by one. Change-Id: I6ec39d00c3beabbc3e661754bac6e43a0fb351d6
2013-06-07 16:57:49 -07:00
JavaScript use policy Add a point to HACKING.rst pointing to the Horizon docs about contributing. Add information about JavaScript support policy to the contributing docs. The policy is based on: http://lists.openstack.org/pipermail/openstack-dev/2013-November/020342.html Change-Id: I16a51c7ab7faf68d6e7984c113da175c5c08650d
2013-11-26 13:14:26 +01:00
- Read the Horizon contributing documentation at http://docs.openstack.org/developer/horizon/contributing.html
Eliminate mutable default arguments The best practice in Python is not to use mutable object (i.e. list, dictionary, or instances of most classes) as value of default argument (see https://goo.gl/Kwhg0T). A hacking rule to enforce this practice is added as well. The patch was inspired by CR https://review.openstack.org/#/c/198465/ and took most of its code from it as well. That's why original copyrights are kept. Closes-Bug: #1471349 Change-Id: Ia77b1736dbc3d4e28ff2d2c3424e9cfcaefa5077
2015-09-21 13:22:59 +03:00
- [M322] Method's default argument shouldn't be mutable.
Copy Permalink