Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Removing section on root-relative imports.
  • Loading branch information
wtgee authored May 27, 2020
1 parent e3f40ca commit 57a9938
Showing 1 changed file with 0 additions and 12 deletions.
12 changes: 0 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,18 +81,6 @@ for more info._
- File names should be lower case and underscored, not contain spaces. For example, `my_file.py`
instead of `My File.py`.
- Define any project specific terminology or abbreviations you use in the file you use them.
- Use root-relative imports (i.e. relative to the POCS directory). This means that rather
than using a directory relative imports such as:
```python
from ..base import PanBase
from ..utils import current_time
```
Import from the top-down instead:
```python
from pocs.base import PanBase
from pocs.utils import current_time
```
The same applies to code inside of `peas`.
- Test imports are slightly different because `pocs/tests` and `peas/tests` are not Python
packages (those directories don't contain an `__init__.py` file). For imports of `pocs` or
`peas` code, use root-relative imports as described above. For importing test packages and
Expand Down

0 comments on commit 57a9938

Please sign in to comment.