[3pt] [Contribution Guide]: TOC revising
Open
Nobody has claimed this yet.
dev_guide
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related to https://github.com/tarantool/doc/issues/1655
Revise high-level CG TOC based on discussion with @Totktonada -- mainly on Development part.
- Introduction (landing page -- revised https://www.tarantool.io/en/doc/latest/contributing/contributing/)
- Development
- Development workflow overview
- Seting up development environment
- Making build
- Running tests
- Coding
- Writting tests
- Before sending patch
- Self-review checklist
- Sending patch
- C style guide
- Lua style guide
- Feedbacks and suggestions
- Submitting feedbacks and suggestions
- Bug reporting -- может относиться сюда, а не к разделу Development; что-то уже есть в док-ции /admin
- Documentation
- Contributing to Tarantool documentation
- Documentation style guide
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading related issue 1655 and the revised landing page at https://www.tarantool.io/en/doc/latest/contributing/contributing/. Compare the current high-level Contribution Guide TOC with the proposed Development, Feedbacks and suggestions, and Documentation sections; done means the TOC reflects the agreed structure, including the placement of bug reporting.
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
- Mostly clear
- Newbie friendliness
- 35/100