Skip to content

Commit 65d8b99

Browse files
committed
Started dev setup and code standards docs, re #2.
1 parent 4caf32c commit 65d8b99

2 files changed

Lines changed: 48 additions & 2 deletions

File tree

docs/contributing/devsetup.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,3 @@
77
Developer Setup
88
===============
99

10-
**Coming soon...**

docs/contributing/standards.rst

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,51 @@
77
Coding Standards
88
================
99

10-
**Coming soon...**
10+
Deis is a `python`_ project. We chose python over other compelling
11+
languages because it is widespread, well-documented, and friendly to
12+
a large number of developers. We think open source code benefits from
13+
many eyes upon it.
14+
15+
Contributors to deis should feel welcome to make changes to any part
16+
of the codebase. To create a proper github pull request for inclusion
17+
into the official repository, your code must pass two tests:
18+
19+
- :ref:`flake8`
20+
- :ref:`coverage`
21+
22+
23+
.. _flake8:
24+
25+
``make flake8``
26+
---------------
27+
28+
::
29+
30+
$ cd $HOME/projects/deis
31+
$ make flake8
32+
flake8
33+
$
34+
35+
36+
.. _coverage:
37+
38+
``make coverage``
39+
-----------------
40+
41+
::
42+
43+
$ cd $HOME/projects/deis
44+
$ make coverage
45+
coverage run manage.py test api celerytasks client web
46+
Creating test database for alias 'default'...
47+
...................ss.
48+
----------------------------------------------------------------------
49+
Ran 22 tests in 22.630s
50+
51+
OK (skipped=2)
52+
Destroying test database for alias 'default'...
53+
coverage html
54+
$
55+
56+
57+
.. _python: http://www.python.org/

0 commit comments

Comments
 (0)