apache / apache/incubator-graphar

[Doc] [Improvement] prepare a more beginner-friendly developer documentation for the C++ library

Open
#498 1 comment 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
C++
Stars
373
Forks
93
Avg merge
7d 21h
Merged PRs (30d)
7

Description

### Describe the enhancement requested

prepare a more beginner-friendly developer documentation for the C++ library

For the time being it will be prepared to include the following sections

- [ ] Explain some basic concepts for beginner developers
- [ ] An introduction to good first issue
- [ ] Specific open source development process
- [ ] A detailed example of using dev container

### Component(s)

Documentation

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing developer documentation for the C++ library and any current dev-container guidance. Define the four requested sections from the issue, then check with maintainers where they belong and what project-specific examples are accurate. Done means the beginner concepts, good-first-issue introduction, open-source process, and detailed dev-container example are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.