reactive-python / reactive-python/reactpy
Use snake_case for components
Open
Nobody has claimed this yet.
priority-3-low
type-docs
type-investigation
- Dominant language
- Python
- Stars
- 8.1k
- Forks
- 332
- PR merge metrics
- No merged PRs in 30d
Description
Current Situation
We currently promote using PascalCase for components, following ReactJS convention. However, this very much goes against PEP8.
See original discussion:
Proposed Actions
Rewrite the docs to promote snake_case usage.
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 documentation covering component naming and the original discussion linked in the issue. Update the relevant guidance to promote snake_case instead of PascalCase, then check that the documentation consistently reflects the new convention.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100