openlibhums / openlibhums/memory-alpha
Choose and document a style guide for HTML, CSS, and JS
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 0
- Forks
- 0
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 2
Description
Description or user story
We have discussed standardizing our style choices for HTML, CSS, and JS, such as 80-character line breaks and 2-space indentation.
Update 27 Jan 2025:
After some experimentation and discussion (below) it is apparent that this touches on many things, and the solution comes in several parts. Some things can be automated (like indentation in HTML and CSS files), and some things will require a style guide or component usage documentation that developers have to interpret and apply manually: like having one h1 per page, or whether or not to use all caps in our designs, or how to use color pairs. A lot of these will be put into a design system when and if we adopt / create one.
Because the automatic bits are lower-hanging fruit and can be implemented more quickly, I'd like to split them off. One that comes to mind is:
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 reading the discussion on this issue and the linked issue #130, since the work has been split into automated formatting and broader style or design-system guidance. Clarify which part remains here and define completion criteria before choosing documentation locations or implementation work; no files or tests are named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- css, html, javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100