We frequently receive requests to add new features to CADET-Process or to fix bugs, and we are very grateful to everyone who contacts us and helps us improve our software. This post aims to provide guidance for those less experienced with software engineering and git workflows on how to install and test these new features.
First, we recommend reading our Contributor’s Guide. Note that the guide is relatively new, so any feedback is welcome.
When new features are added or bugs are fixed, we typically push these changes to a new branch in our git repository, which you will need to install (e.g., fix/spreading_solution). To use that branch, you can either check out the branch directly or install it in your environment with:
pip install git+https://github.com/fau-advanced-separations/CADET-Process.git@fix/spreading_solution
Additionally, we use pull requests (PR) on GitHub to discuss and review these changes on that branch before merging them into our main branch (e.g., dev or master). For example: #289.