[DOC] add guildelines on type hints
Open
Nobody has claimed this yet.
documentation
pyfar-workflow
retreat 2026
- Dominant language
- Python
- Stars
- 3
- Forks
- 2
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 3
Description
Maybe we should decide whether to require type hints or not.
Once we reach a decision, it should be added to the documentation guidelines.
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 existing documentation guidelines and the linked type-hints reference. Determine whether the project should require type hints, then record the agreed policy in the documentation guidelines. Done means the decision is explicit and the guidelines reflect it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100