Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs through Github
If you are reporting a bug, please include:
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
We've created the operators, hooks, macros and executors we needed, but we made sure that this part of Panoramix is extensible. New operators, hooks and operators are very welcomed!
Panoramix could always use better documentation, whether as part of the official Panoramix docs, in docstrings, docs/*.rst
or even on the web as blog posts or articles.
The best way to send feedback is to file an issue on Github.
If you are proposing a feature:
# fork the repo on github and then clone it # alternatively you may want to clone the main repo but that won't work # so well if you are planning on sending PRs # git clone git@github.com:mistercrunch/panoramix.git # [optional] setup a virtual env and activate it virtualenv env source env/bin/activate # install for development python setup.py develop # Create an admin user fabmanager create-admin --app panoramix # Initialize the database panoramix db upgrade # Create default roles and permissions panoramix init # Load some data to play with panoramix load_examples # start a dev web server panoramix runserver -d
For every development session you may have to
Tests can then be run with:
./run_unit_tests.sh
Lint the project with:
flake8 changes tests
Generate the documentation with:
cd docs && ./build.sh
Before you submit a pull request from your forked repo, check that it meets these guidelines:
from __future__ import
will be required in every .py
file soon.