Skip to content

Commit

Permalink
Adding contributor guidelines.
Browse files Browse the repository at this point in the history
  • Loading branch information
jiffyclub committed Jul 2, 2014
1 parent 18891ff commit 38d1388
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,41 @@
Contributing to ActivitySim
===========================

Style
-----

- Python code should follow the [PEP 8 Style Guide][pep8].
- Python docstrings should follow the [NumPy documentation format][numpydoc].

### Imports

Imports should be one per line.
Imports should be grouped into standard library, third-party,
and intra-library imports. `from` import should follow "regular" `imports`.
Within each group the imports should be alphabetized.
Here's an example:

```python
import sys
from glob import glob

import numpy as np

import urbansim.urbansim.modelcompile as modelcompile
from urbansim.util import misc
```

Imports of scientific Python libraries should follow these conventions:

```python
import matplotlib.pyplot as plt
import numpy as np
import pandas as pd
import scipy as sp
```


Thanks!

[pep8]: http://legacy.python.org/dev/peps/pep-0008/
[numpydoc]: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

0 comments on commit 38d1388

Please sign in to comment.