Giters

open-sauced / intro

Empowering Your Open Source Journey: From First Contribution to Project Leadership

Home Page:https://opensauced.pizza/learn

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

docs: Fix and Improve `CONTRIBUTING.md` and `i18n-guidelines.md`

adiati98 opened this issue · comments

commented

Description

The CONTRIBUTING.md contains some mistakes that need to be fixed, such as jumping numbers in the ordered lists, typos, missing markdowns on code blocks, etc. Below are the screenshots of a couple of examples:

Unordered number in ordered list:

ordered-list-mistake

An example of code block that needs to be written in markdown:

sample of need markdown

Typo

typo

Improving README and i18n Guidelines

There are also opportunities for enhancement by reorganizing and updating the docs as follow:

  • Update and organize the README.
  • Move "Adding Translations to Documentation" from README to i18n-guidelines.md.
  • Organize the i18n Guidelines.

Suggestion Solution

  • Fix things that need to be fix here.
  • Reorganize and improve the README and i18n guidelines for more clarity.