tarantool / tarantool/queue

Rework documentation

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

Nobody has claimed this yet.

documentation
Dominant language
Lua
Stars
244
Forks
56
PR merge metrics
No merged PRs in 30d

Description

Right now the README queue is overloaded and difficult to read.
I suggest the following steps to make the situation better:

  • tarantool/queue#172
  • tarantool/queue#173
  • tarantool/queue#169

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

Start with the README and review tarantool/queue#172, tarantool/queue#173, and tarantool/queue#169 to understand the documentation items being referenced. Rework the README queue so it is easier to read, and confirm that the listed items are clearly organized and complete.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
3-5 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.