openclimatefix / openclimatefix/ocf-data-sampler
Naming conventions. Prefix vs suffix?
Open
Nobody has claimed this yet.
discussion
ocf-internal
- Dominant language
- Python
- Stars
- 20
- Forks
- 43
- PR merge metrics
- No merged PRs in 30d
Description
What should our naming conventions be? da_nwp? nwp_config?
Evaluate the library to see if there is already a dominant way of naming things and see if we can figure out some convention
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
Review the repository to identify the dominant naming patterns, focusing on examples such as da_nwp and nwp_config. Document a consistent prefix-versus-suffix convention and define done as having an agreed naming rule that can guide future library changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100