libgit2 / libgit2/rugged

[RFC] Semantic Versioning

Open
#472 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
2.3k
Forks
293
PR merge metrics
No merged PRs in 30d

Description

I've been thinking a bit about changing Rugged to use Semantic Versioning.

I tried to follow the libgit2 version number in the latest Rugged releases,
but that's not been working out really well. One thing that is a bit bugging
me (and probably other users) is that Rugged releases are very infrequent and
inconsistent, and I'd like that to change.

Now, I'd like to move to a more consistent versioning scheme and follow
the guidelines of SemVer.

Here's a short rundown how I imagine this would look like:

  • Development against libgit2 from git will happen in the master branch,
    as it does right now already. Beta releases will be cut from there and their
    version number will either be MINOR+1 or MAJOR+1, depending on whether
    newer changes break backwards compatibility or not.
  • We'll keep maintaining PATCH releases for MINOR versions for as long as
    the matching libgit2 version receives updates.

Any comments or concerns?

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

No files, tests, or entry points are named. Start by reviewing Rugged's existing release process and how releases track libgit2. Done means agreeing on and documenting a Semantic Versioning policy covering master, beta releases, and maintained patch releases.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, ruby
Domain
release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.