oppia / oppia/oppia-web-developer-docs

Typo in Coding Style Guide

Open Beginner friendly
#515 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
18
Forks
134
PR merge metrics
No merged PRs in 30d

Description

Describe the bug

There are several typos that I observe in the Coding Style Guide doc.

Avoid introducing TODO (#XYZ): ... comments in the files and instead try to do things correctly the first time. If you are going to add a TODO comment in any file then there needs to be (at minimum) a full comment and justification explaining what has been tried and what the issue is. The TODo should also reference an issue created on GitHub for thracking the problem.

Avoid introducing TODO (#XYZ): ... comments in the files and instead try to do things correctly the first time. If you are going to add a TODO comment in any file then there needs to be (at minimum) a full comment and justification explaining what has been tried and what the issue is. The TODo should also reference an issue created on GitHub for thracking the problem.

I would be happy to fix this issue, as I have just passed my TOEFL certification, so you can assign it to me.

URL of the page where the issue is observed.

Page link: https://github.com/oppia/oppia-web-developer-docs/blob/develop/Coding-style-guide.md

Steps To Reproduce

Go to the link, scroll down to General section

Expected Behavior

"TODo" should be corrected to be "TODO"
"Thracking" should be corrected to be "Tracking"

Screenshots/Videos
Image
What device are you using?

Laptop

Operating System

Ubuntu v22

Tips for developers
Before addressing the bug, please identify which PR caused the issue (you can follow the steps here). If you identify the PR, comment on the issue with a link to it. If not, mention the commit hash of the oldest commit you saw the bug on (and the month and year it was made in).

Then, please leave a comment with details of the approach that you plan to take to fix the issue (see https://github.com/oppia/oppia/issues/19157#issuecomment-1858788463).

Note: If this is your first Oppia issue, please make sure to follow our guidelines for choosing an issue and setting things up. You will also need to show a demo of the fix working correctly on your local machine. Thanks!

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.

Research direction

Open Coding-style-guide.md from the linked page and go to the General section. Review the TODO guidance where the misspellings appear, correct “TODo” to “TODO” and “thracking” to “tracking,” then verify both typos are fixed in the rendered documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.