NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-12-26 23:27:46 -06:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Expanded the development style guide

Browse Source
This commit is contained in:
Jeremy Stretch
2018-11-12 14:36:09 -05:00
parent 5785fb6ba2
commit b6a256dc5d
3 changed files with 42 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/development/index.md
View File

@@ -28,10 +28,3 @@ NetBox components are arranged into functional subsections called _apps_ (a carr
* `tenancy`: Tenants (such as customers) to which NetBox objects may be assigned
* `utilities`: Resources which are not user-facing (extendable classes, etc.)
* `virtualization`: Virtual machines and clusters
## Style Guide
NetBox generally follows the [Django style guide](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/), which is itself based on [PEP 8](https://www.python.org/dev/peps/pep-0008/). The following exceptions are noted:
* [Pycodestyle](https://github.com/pycqa/pycodestyle) is used to validate code formatting, ignoring certain violations. See `scripts/cibuild.sh`.
* Constants may be imported via wildcard (for example, `from .constants import *`).