moodle / moodle/devdocs

[repo] Create coding styles

Open
#48 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug enhancement help wanted migration repo
Dominant language
TypeScript
Stars
74
Forks
652
Avg merge
2d 50m
Merged PRs (30d)
12

Description

We need to document our various coding styles for:

  • Javascript
  • Markdown
  • CSS
  • JSX

We should also provide appropriate linting and related tools where possible.

Part of this work is covered by #40 but we need to turn this into a written coding style to make it easier to understand.

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

No files, tests, or entry points are named. Review the work covered by #40 first, then document the JavaScript, Markdown, CSS, and JSX coding styles and identify appropriate linting or related tools where possible. Done means each listed style has written guidance and the tooling recommendations are recorded.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, javascript, markdown
Domain
documentation, tooling
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.