-
Notifications
You must be signed in to change notification settings - Fork 82
Problems during contribution process
Philipp Mehrfeld edited this page Apr 18, 2019
·
1 revision
Sometimes git shows lots of changed files. Often this is due to
- Encoding of files changed
- Model files are auto formatted
Both might be due to built-in functions of Dymola. Everything is discussed in this issue.
We agreed to follow a procedure (see this comment) in order to separate changes from each other:
a) made in the context of a certain feature implementation or bug fix
from
b) made to saving the whole library and Dymola changes file encodings and restructure code (auto formatting).
The procedure is as following:
- branch away from
development
calling the branch e.g.issue123_DymolaAutoFormat
- save the whole AixLib and make a single commit
- merge branch
issue123_DymolaAutoFormat
back intodevelopment
- update your branch
issue123_featureDev
(if already exist) by mergingdevelopment
into your branch - do e.g. refactoring + write conversion script
In this context there exist some interesting flags:
Dymola flags:
- Boolean
Advanced.AlwaysWriteUTF8 = false
"If true write UTF-8 files even if only ASCII contents. Can be changed without new translation of model"; - Integer
Advanced.MaxLineLength = 80
"The maximum length of lines for automatic formatting (default 80) cannot be <50";
Git flag / setting:
-
git config core.autocrlf input
(or even:git config --global core.autocrlf input
)
- Getting started
-
Modeling and simulation guide
- Modelica guidelines
- How to Modelica
- Important tools around AixLib
- Move from HeatPump to ModularReversible
-
Contribution guide
- Git Workflow
- Structure of Repository
- Behind the Scenes
- Contribute to AixLib
- Testing and model quality management
- Requirements
- Test Management
- Continuous Integration