1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-02-22 12:58:36 +00:00

Updating contribution guidelines.

Clarifying style guidelines and refering "Writing Extensions" section.
This commit is contained in:
Sergei Trofimov 2015-06-01 10:36:21 +01:00
parent 578dfb3d99
commit c550657912
2 changed files with 17 additions and 4 deletions

View File

@ -4,10 +4,21 @@ Contributing Code
We welcome code contributions via GitHub pull requests to the official WA We welcome code contributions via GitHub pull requests to the official WA
repository. To help with maintainability of the code line we ask that the code repository. To help with maintainability of the code line we ask that the code
uses a coding style consistent with the rest of WA code, which is basically uses a coding style consistent with the rest of WA code. Briefly, it is
`PEP8 <https://www.python.org/dev/peps/pep-0008/>`_ with line length and block
comment rules relaxed (the wrapper for PEP8 checker inside ``dev_scripts`` will - `PEP8 <https://www.python.org/dev/peps/pep-0008/>`_ with line length and block
run it with appropriate configuration). comment rules relaxed (the wrapper for PEP8 checker inside ``dev_scripts``
will run it with appropriate configuration).
- Four-space indentation (*no tabs!*).
- Title-case for class names, underscore-delimited lower case for functions,
methods, and variables.
- Use descriptive variable names. Delimit words with ``'_'`` for readability.
Avoid shortening words, skipping vowels, etc (common abbreviations such as
"stats" for "statistics", "config" for "configuration", etc are OK). Do
*not* use Hungarian notation (so prefer ``birth_date`` over ``dtBirth``).
New extensions should also follow implementation guidelines specified in
:ref:`writing_extensions` section of the documentation.
We ask that the following checks are performed on the modified code prior to We ask that the following checks are performed on the modified code prior to
submitting a pull request: submitting a pull request:

View File

@ -1,3 +1,5 @@
.. _writing_extensions:
================== ==================
Writing Extensions Writing Extensions
================== ==================