/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. Development Introduction
  6. ========================
  7. Here's how we do things in circuits...
  8. Communication
  9. -------------
  10. - `IRC Channel`_ on the `FreeNode IRC Network`_
  11. - `Developer Mailing List`_
  12. - `Issue Tracker`_
  13. .. note:: If you are familiar with `IRC <http://en.wikipedia.org/wiki/Internet_Relay_Chat>`_
  14. and use your own IRC Client then connect to the FreeNode Network and ``/join #circuits``.
  15. Standards
  16. ---------
  17. We use the following coding standard:
  18. - `pep8 <http://www.python.org/dev/peps/pep-0008/>`_
  19. We also lint our codebase with the following tools:
  20. - `pyflakes <https://pypi.python.org/pypi/pyflakes>`_
  21. - `pep8 <https://pypi.python.org/pypi/pep8>`_
  22. - `mccabe <https://pypi.python.org/pypi/mccabe/0.2.1>`_
  23. Please ensure your Development IDE or Editor has the above
  24. linters and checkers in place and enabled.
  25. Alternatively you can use the following command line tool:
  26. - `flake8 <https://pypi.python.org/pypi/flake8>`_
  27. Tools
  28. -----
  29. We use the following tools to develop circuits and share code:
  30. - **Code Sharing:**
  31. `Mercurial <http://mercurial.selenic.com/>`_
  32. - **Code Hosting and Bug Reporting:**
  33. `BitBucket <https://bitbucket.org/circuits/circuits>`_
  34. `GitHub <https://github.com/circuits/circuits>`_ (*Mirror Only*)
  35. - **Issue Tracker:**
  36. `Issue Tracker <https://bitbucket.org/circuits/circuits/issues>`_
  37. - **Documentation Hosting:**
  38. `Read the Docs <http://circuits.readthedocs.org>`_
  39. - **Package Hosting:**
  40. `Python Package Index (PyPi) <http://pypi.python.org/pypi/circuits>`_
  41. - **Continuous Integration:**
  42. `Drone <https://drone.io/bitbucket.org/circuits/circuits>`_