Table of Contents Technical hints for contributors How to contribute 1. Fork the repository 2. Clone the repository from your fork 3. Create your feature branch 4. Push your feature branch to your github fork 5. Create a pull request. How to contribute to the homepage How to test a package on pypitest How to use Pypi How to contribute 1. Fork the repository 2. Clone the repository from your fork 3. Create your feature branch 4. Push your feature branch to your github fork 5. Create a pull request. 1. Fork the repository 2. Clone the repository from your fork 3. Create your feature branch 4. Push your feature branch to your github fork 5. Create a pull request. How to contribute to the homepage How to test a package on pypitest How to use Pypi Release Process 1. Bump Version Number 2. Test 3. Rebuild docs 4. Build a python wheel 5. Create a git tag 6. Upload to PyPi test 7. Git Release 8. Upload to PyPi 8. Build docker container 10. Prepare repository for further development 1. Bump Version Number 3. Rebuild docs 4. Build a python wheel 5. Create a git tag 6. Upload to PyPi test 8. Upload to PyPi 8. Build docker container 10. Prepare repository for further development Sequence code documentation Contributors & Background How to contribute ¶ 1. Fork the repository ¶ Forking a repository on github means creating a clone of a repository on github. Simply click on “Fork” in the TRAL repos TRAL repository once you have a Github account. 2. Clone the repository from your fork ¶ From the command line, create a clone of your fork: 3. Create your feature branch ¶ If you use git-flow, start a new feature: Otherwise, create a new branch as follows: Next, add the necessary changes and commit them: 4. Push your feature branch to your github fork ¶ 5. Create a pull request. ¶ Create the pull request online on github. For this, go to your github page and click on “Pull Request”. Do a pull request on the develop branch of acg-team/tral. How to contribute to the homepage ¶

Check out the current version of the TRAL homepage as follows: How to test a package on pypitest ¶ Install the package from pypitest as follows: How to use Pypi ¶ This documentation summarizes the steps to a new release of TRAL. Version number updates tral/__init__.py tral/__init__.py 1. Bump Version Number ¶ Change version in: tral/__init__.py tral/__init__.py Run all tests again. Make sure, that pytest is installed in the virtual environment. 3. Rebuild docs ¶ The documentation is build with sphinx . Check if all external links are correct, update and commit if necessary. Checkout branch develop: Move into ‘./tral/docs’ directory and build the docs: The new docs are stored in ./tral/docs/_build/html/ . Copy them outside the git repository and checkout to the gh-pages branch. Move the fresh build docs to gh-pages : [CHECK IF THIS IS CORRECT] Check the updated docs online (synchronizes automatically) at acg-team.github.io . 4. Build a python wheel ¶ 5. Create a git tag ¶ -s requires a gpg key . 6. Upload to PyPi test ¶ Check the wheel and git tag: Upload to PyPi test platform first: 7. Git Release ¶ 8. Upload to PyPi ¶ 8. Build docker container ¶ Create Github.com Token and login your docker instance: We encountered issues if not all tral related docker container and images were stopped and removed. Continue then with building a new docker image with the new release: 10. Prepare repository for further development ¶ Increment version in __init_.py from i.e. 2.0.0 to 2.0.1.dev0 .