Duplicate .clang-format file in OpenFOAM cases
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 142
- Forks
- 167
- Avg merge
- 20h 24m
- Merged PRs (30d)
- 11
Description
While we have a central .clang-format file for the tutorials, we also have such a file for the OpenFOAM solver in the partitioned heat conduction case. We need this mainly because the default format moves around header inclusions, which breaks OpenFOAM code (we need to set SortIncludes: false). This is already a duplicate of the file used in the OpenFOAM adapter, and other PRs are introducing more duplication (such as https://github.com/precice/tutorials/pull/551).
We could maybe move the OpenFOAM-specific file to tools/ for now, and link to it from the various directories.
Note that we are also working on a community proposal, which we could maybe one day import.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the central .clang-format in the tutorials with the duplicate used by the OpenFOAM solver in the partitioned heat conduction case and the OpenFOAM adapter. Read the existing formatting configuration and inspect the relevant case directories before deciding whether tools/ is the shared location. Done means one OpenFOAM-specific configuration is maintained and the affected directories link to it without losing SortIncludes: false.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100