CompassSoftware / CompassSoftware/AppTAG

Use Good/Better Names

Open
#64 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

We are starting to pile up asset images and JS files. And some poor naming needs to be addressed sooner rather than later.

Kudos to whomever did assets/Panels/RoomOne folder for the room 1 info panels! (So do we need the assets/Activity1.png anymore?)

zero_lesson, etc. need to be more descriptive. How about R0_TagIntro? It conveys the room # and it's purpose. Then there could be R1_CourseIntro and R2_FinStms etc.

Other naming improvements maybe???

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inventorying the asset and JavaScript filenames mentioned in the issue, including assets/Panels/RoomOne, assets/Activity1.png, and zero_lesson. Review the proposed R0_TagIntro, R1_CourseIntro, and R2_FinStms pattern, then confirm the naming scope and whether obsolete assets remain. Done is not currently defined because the issue leaves other naming improvements open.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.