Extending Code Development guide in WORKFLOW wiki
It is not crystal clear to me from the "Code development" Wiki entry how I should get started with contributing code. The most essential piece of information missing is that the OpenFOAM-plus develop branch pairs with the ThirdParty-plus develop branch. This may be obvious, but it should still be explicitly mentioned also to avoid developers forgetting to checkout develop in both repos before trying to compile OpenFOAM-plus.
I suggest extending the WORKFLOW wiki for code developments with a short build guide. Something like:
Workflow
If not already installed, download the OpenFOAM-plus and ThirdParty-plus repositories to your local OpenFOAM installation directory:
- cd ~/OpenFOAM
- git clone https://develop.openfoam.com/Development/OpenFOAM-plus.git
- git clone https://develop.openfoam.com/Development/ThirdParty-plus.git
All new code/features/bug-fixes should be created on their own branch, e.g. starting from the develop branch. Remember to
- cd ThirdParty-plus
- git checkout develop
- cd ../OpenFOAM-plus
- git checkout develop
Create and move to a new branch:
- git checkout -b feature-ABC (or git checkout -b bugfix-ABC etc)
Add functionality in the usual way, e.g. adding and committing code changes.
Note that I removed the first item in the original text:
- git branch develop --track remotes/origin/develop which seems unnecessary (right?).