Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in many ways:
Please consider contributing any data components your develop back to the Jetstream community.
In the naming of any contributed component package, please use form jetstream.<title><type> where <type> is the component type (input/ introspect/transform/output), and <title> describes the functionality. For example ‘jetstream.podioinput’ would be the name of an Input component that reads data from the Podio (http://www.podio.com) service via its HTTP API.
Also, please add “jetstream” as a package keyword.
Report bugs at https://github.com/koodaamo/jetstream/issues.
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.
Jetstream could always use more documentation, whether as part of the official jetstream docs, in docstrings, or even on the web in blog posts, articles, and such.
Look through the GitHub issues for features. Anything tagged with “docs” is open to whoever wants to add the documentation.
The best way to send feedback is to file an issue at https://github.com/koodaamo/jetstream/issues.
If you are proposing a feature:
Ready to contribute? Here’s how to set up jetstream for local development.
Fork the jetstream repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/jetstream.git
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv jetstream
$ cd jetstream/
$ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 jetstream tests
$ python setup.py test
$ tox
To get flake8 and tox, just pip install them into your virtualenv.
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
Submit a pull request through the GitHub website.
Before you submit a pull request, please check that it meets these guidelines: