iiitv / iiitv/ChefLib

ADD_ME_IN_README.md needs improvement

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

Nobody has claimed this yet.

enhancement status/inactive
Dominant language
C++
Stars
64
Forks
61
PR merge metrics
No merged PRs in 30d

Description

#### We need to add every explanation in a new line and try to make it more interactive.
- [x] This issue is for enhancement.
- [x] I will send my PR only after I'm assigned to this issue by any maintainer.
- [x] I ensure that I'm not assigned to more than 2 issues.
- [x] Assign this issue to me (I want to work on this).

##### It's not necessary for all for points to be checked, we will look at what is required once you open an issue.

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 reading ADD_ME_IN_README.md and reviewing which explanations are currently present and how they are formatted. The issue does not identify specific missing content or an interaction design; confirm the requested scope with maintainers, and consider the work done when the agreed explanations are separated clearly and the agreed interactive improvements are documented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.