ml-explore / ml-explore/mlx-examples
linting / type definitions
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9k
- Forks
- 1.2k
- PR merge metrics
- No merged PRs in 30d
Description
Origin of this issue
@Jonathan-Dobson if you put the linting / type checking commands you use into a separate issue that would be the best way for us to go about getting them resolved. That way we can reproduce them and fix them. (You are also welcome to send PRs yourself if you feel comfortable doing so).
Originally posted by @awni in https://github.com/ml-explore/mlx-examples/issues/973#issuecomment-2329024528
Does the community have any preferences about type definitions?
Are there any preferences, recommendations, or general guidelines that should be adhered to aside from the contributing readme, as we build in type definitions?
High priority files that need type definitions added first. List here.
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
Start with the contributing README and the linting and type-checking commands referenced in the issue's origin. Determine which project files are intended to receive type definitions and what guidelines apply; the issue's empty high-priority list means completion criteria still need to be established.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100