a622e99e93
1) Update doc links according to OpenStack document migration 2) Use https instead of http for docs links Change-Id: I2b90bf308c55264e2aa7e2035611f49db179fa60
36 lines
732 B
Markdown
36 lines
732 B
Markdown
# ORM discovery readme file
|
|
|
|
This document includes the following topics
|
|
1. Dev environment installation process
|
|
1. Code style guide
|
|
1. Python tips and tricks
|
|
|
|
|
|
## Dev Environment installation process
|
|
This project is python based so you need to have python 2.7 installed before continuing
|
|
|
|
|
|
_TBD_
|
|
|
|
## Code style guide
|
|
First of all please read two of the following documents:
|
|
1. [Pythons PEP8](https://www.python.org/dev/peps/pep-0008/)
|
|
1. [Openstack hacking](https://docs.openstack.org/hacking/latest/)
|
|
|
|
__After reading this please read it 3 more times__
|
|
|
|
### Folders
|
|
Folders names should be lowercase, if needed delimited by underscore
|
|
|
|
do:
|
|
```
|
|
business_logic
|
|
```
|
|
not
|
|
```
|
|
BusinessLogic
|
|
```
|
|
## Python tips and tricks
|
|
|
|
# test header
|