mdolab / mdolab/adflow

Code styling consistency

Open
#252 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Fortran
Stars
332
Forks
124
PR merge metrics
No merged PRs in 30d

Description

Description of feature

Most of ADflow is in camelCase, but it is not completely consistent. I personally don't prefer using camelCase for all variables since it makes it difficult to read in my opinion. I also am not sure if this is consistent with pep8.

In #231 I introduced some changes that uses an underscore based naming change. I changed all my changes to camelCase in the python changes but left the fortran changes as is for now. Creating this issue so we can further discuss with @eirikurj.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the naming changes introduced in issue #231 and comparing the current Python and Fortran conventions with PEP 8. Discuss the preferred convention with the maintainers, then apply the agreed style consistently across the affected code; completion depends on that decision.

Written by the indexing model from the issue text.

Assessment

Tech stack
fortran, python
Domain
developer-experience
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.