Enforce python naming convention
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 0
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Description of feature
Our python code is mostly CamelCase, but there are exceptions. To keep the python MDO Lab codebase and APIs consistent and predicable, we could and probably should integrate some tools into our testing to enforce this.
Potential solution
There are several tools available, but one option that fits into our current tools is to use the flake8 extension, pep8-naming.
Feel free to suggest other tools or approaches.
Contributor guide
No contributing guide indexed for this repository
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
Start by reviewing the repository's existing testing and tooling setup, then evaluate the proposed pep8-naming flake8 extension. Confirm how naming checks should be integrated and which existing Python checks they should cover; done means the agreed convention is enforced by the test tooling.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100