Skip to content

Development

How-to

Make sure to install all the dev packages in your local environment::

   pip install -r requirements-dev.txt

  • Making the documentation::

       mkdocs build
   mkdocs serve

  • Deploying documentation: 

       mkdocs gh-deploy

  • Testing: TODO

  • Coverage: TODO

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Report Bugs

Report bugs at https://github.com/virantha/circuitbrew/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation

CircuitBrew could always use more documentation, whether as part of the official CircuitBrew docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/virantha/circuitbrew/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up circuitbrew for local development.

  1. Fork the circuitbrew repo on GitHub.
  2. Clone your fork locally::
    $ git clone git@github.com:your_name_here/circuitbrew.git

  1. Use hatch to enable your environment

    $ hatch shell

  2. Create a branch for local development::

    $ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. When you're done making changes, check that your changes pass tests::

    $ TBD

To get tox, just pip install them into your virtualenv.

  1. Commit your changes and push your branch to GitHub::

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  2. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.11. Check https://travis-ci.org/virantha/circuitbrew/pull_requests and make sure that the tests pass for all supported Python versions.