We welcome any contribution to our open source projects. If you want to participate in our work, make sure to read our software development principles before you start.
You can manage the development environment of pyorbs with pyorbs itself. If you already have pyorbs
installed you can simply execute
orb -m pyorbs within the project folder, after which you can
orb pyorbs and
pip install -e . to install the
orb command inside the
pyorbs orb. This allows you to develop and test the
orb command itself while the
orb is active.
Make sure to test pyorbs on all supported shells that are listed in the Features section of the documentation (for this you will need to install all of these shells on your system).
You can make a new release as follows:
Make sure the changelog is properly updated.
Create a pull request and ask for review.
Once the pull request has been approved, increase the version number using
Merge the pull request.
Create a new distribution and upload it to test.pypi.org:
$ make dist $ twine upload --repository-url https://test.pypi.org/legacy/ dist/*
Check if your distribution works properly:
$ pip3 install --index-url https://test.pypi.org/simple/ pyorbs $ orb -v
Finally, upload the new distribution to PyPI:
$ twine upload dist/*
Once the new version has been uploaded, Webrepublic’s Concourse cluster will take care of all further deployment steps, such as building and publishing the documentation or updating the various Docker base images.