|
|
# Workflow
|
|
|
# About This Site
|
|
|
This site provides users with access to the latest version of OpenFOAM and a platform to submit feedback, e.g. bug reports and feature requests. Please note that this is not a forum for general user support. For information related to our latest service offerings, please visit www.openfoam.com/services/.
|
|
|
|
|
|
## Structure
|
|
|
There are 3 main branches
|
|
|
- master: always 'runnable' code, e.g. could be used by customers
|
|
|
- develop: current developments, waiting to be pushed into the master
|
|
|
- foundation: mirror of the Foundation master branch
|
|
|
# Providing Feedback
|
|
|
Users can provide feedback by submitting 'issues'; please see the page [Submitting Issues](page-submitting-issues)
|
|
|
|
|
|
## Operation
|
|
|
Create a tracking branch to track the 'develop' branch:
|
|
|
- git branch develop --track remotes/origin/develop
|
|
|
|
|
|
All new code/features/bug-fixes should be created on their own branch, e.g.:
|
|
|
- git checkout develop
|
|
|
- git checkout -b feature-ABC (or git checkout -b bugfix-ABC etc)
|
|
|
- This will switch to your newly created branch, to which you apply your code changes
|
|
|
- On completion, merge the code back into the 'develop' branch, e.g.
|
|
|
- git checkout develop
|
|
|
- git merge feature-ABC
|
|
|
- If the branch is no longer needed, delete it!
|
|
|
- git branch -d feature-ABC
|
|
|
- Repeat!
|
|
|
|
|
|
Periodically when code in the 'develop' branch is stable, merge the develop branch into the 'master' branch. Similarly, the 'develop' branch will be updated from the 'foundation' branch.
|
|
|
|
|
|
For code review (as needed) push your feature/bugfix branch to Gitlab, and issue a merge request into the 'develop' branch. |
|
|
# Code Development
|
|
|
For details on our suggested git-based workflow, please see the page [Code Development](page-code-development) |