PageRenderTime 12ms CodeModel.GetById 6ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/source/dev/introduction.rst

https://bitbucket.org/prologic/circuits/
ReStructuredText | 64 lines | 42 code | 22 blank | 0 comment | 0 complexity | 3edafeb350832e3f410c8213b2381503 MD5 | raw file
 1.. _Developer Mailing List: http://groups.google.com/group/circuits-dev
 2.. _Issue Tracker: https://bitbucket.org/circuits/circuits/issues
 3.. _FreeNode IRC Network: http://freenode.net
 4.. _IRC Channel: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4
 5
 6
 7Development Introduction
 8========================
 9
10
11Here's how we do things in circuits...
12
13
14Communication
15-------------
16
17- `IRC Channel`_ on the `FreeNode IRC Network`_
18- `Developer Mailing List`_
19- `Issue Tracker`_
20
21
22.. note:: If you are familiar with `IRC <http://en.wikipedia.org/wiki/Internet_Relay_Chat>`_
23          and use your own IRC Client then connect to the FreeNode Network and ``/join #circuits``.
24
25
26Standards
27---------
28
29We use the following coding standard:
30
31- `pep8 <http://www.python.org/dev/peps/pep-0008/>`_
32
33We also lint our codebase with the following tools:
34
35- `pyflakes <https://pypi.python.org/pypi/pyflakes>`_
36- `pep8 <https://pypi.python.org/pypi/pep8>`_
37- `mccabe <https://pypi.python.org/pypi/mccabe/0.2.1>`_
38
39Please ensure your Development IDE or Editor has the above
40linters and checkers in place and enabled.
41
42Alternatively you can use the following command line tool:
43
44- `flake8 <https://pypi.python.org/pypi/flake8>`_
45
46
47Tools
48-----
49
50We use the following tools to develop circuits and share code:
51
52- **Code Sharing:**
53  `Mercurial <http://mercurial.selenic.com/>`_
54- **Code Hosting and Bug Reporting:**
55  `BitBucket <https://bitbucket.org/circuits/circuits>`_
56  `GitHub <https://github.com/circuits/circuits>`_ (*Mirror Only*)
57- **Issue Tracker:**
58  `Issue Tracker <https://bitbucket.org/circuits/circuits/issues>`_
59- **Documentation Hosting:**
60  `Read the Docs <http://circuits.readthedocs.org>`_
61- **Package Hosting:**
62  `Python Package Index (PyPi) <http://pypi.python.org/pypi/circuits>`_
63- **Continuous Integration:**
64  `Drone <https://drone.io/bitbucket.org/circuits/circuits>`_