Use snake_case for components

Open
#779 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python, react
Domain
documentation

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.

Description

priority-3-low type-docs type-investigation
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.

Dominant language
Python
Stars
8.1k
Forks
332
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from reactive-python/reactpy

All issues in reactive-python/reactpy

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.