mybb / mybb/docs.mybb.com

Update 'Coding Standards' for 1.9+

Open
#212 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
27
Forks
76
PR merge metrics
No merged PRs in 30d

Description

Reference: https://github.com/mybb/docs.mybb.com/blob/gh-pages/1.6/Coding-Standards.html

Remove HTML Markup

Remove any instance of markup in language files and move markup to templates.

$l['ignore_timezone'] = "<strong>Ignore time zone:</strong>"

$l['ignore_timezone'] = "Ignore time zone"

Remove Colon

Remove instances of ':' at the end of text. Semantically, this is unnecessary.

  • The colon is often seen as unnecessary visual clutter, especially when the input field (like a checkbox or text box) immediately follows the label.
  • Many contemporary web forms and applications omit the colon, relying on the spatial arrangement to signify the label-input relationship.
  • Screen readers often announce the colon, which can add a slight, unnecessary pause or verbal cue for the user. Removing it can lead to a smoother auditory experience.
  • Option text often functions as a mini-heading or label, and headings typically don't end with a colon.

Introduce Capitalisation

Capitalise labels.

$l['ignore_timezone'] = "Ignore time zone"

$l['ignore_timezone'] = "Ignore Time Zone"

Contributor guide

Open the contributing guide

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.

Research direction

Start by reviewing the referenced 1.6/Coding-Standards.html page and locate the current Coding Standards page for 1.9+. Update the guidance to prohibit markup and trailing colons in language strings and require capitalised labels, with examples reflecting each rule.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.