libgit2 / libgit2/www.libgit2.org

Annotated Examples proposal

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

Nobody has claimed this yet.

Dominant language
CSS
Stars
116
Forks
67
PR merge metrics
No merged PRs in 30d

Description

Hi,

I've recently posted a tutorial on my blog about how to traverse a git repository using libgit2 and C++ and I was wondering if would be a good idea to add it (after some editing) to the annotated examples.

My idea is to copy the code explained, replace C++ code with C and use the same formatting used in the Repository Initialization example.

Please let me know if this is ok before I do it and submit it as pull request.

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

Read the linked blog tutorial and the Repository Initialization example first. Confirm that maintainers approve adding an edited, C-based version to the annotated examples; done means the content follows the example's formatting and is submitted as a pull request.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, cpp, git
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.