Development Introduction

Here’s how we do things in circuits…

Communication

• IRC Channel on the FreeNode IRC Network

• Developer Mailing List

• Issue Tracker

Note

If you are familiar with IRC and use your own IRC Client then connect to the FreeNode Network and /join #circuits.

Standards

We use the following coding standard:

• PEP-008

We also lint our codebase with the following tools:

• pyflakes

• pep8

• mccabe

Please ensure your Development IDE or Editor has the above linters and checkers in place and enabled.

Alternatively you can use the following command line tool:

• flake8

Tools

We use the following tools to develop circuits and share code:

• Code Sharing: Git

• Code Hosting and Bug Reporting: GitHub

• Issue Tracker: Issue Tracker

• Documentation Hosting: Read the Docs

• Package Hosting: Python Package Index (PyPi)

• Continuous Integration: Github Actions