Document file name normalization process
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Tool developers may wish to leverage the datasets from a variety of programming languages -- they will need to know what the steps are to normalize names in order to find matching entries in the dataset. (Another option: for file names that get normalized have both normalized and un-normalized file name entries).
It may be useful to provide pre-written helper functions for various popular programming languages to reduce the burden on users.
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
No files, tests, or entry points are named. First trace how file names are normalized in the repository and identify the dataset-facing behavior; document the steps clearly and determine whether the optional cross-language helper functions belong in this issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100