Arch Linux

Llama

Banned

From: St.-Petersburg, Russia

Registered: 2008-03-03

Posts: 1,379

Open source software versioning gudelines

I've got a small CLI utility, created for domestic use. It may be of some interest to the general public, or it may not. This is a subject of another topic, anyway. So far the utility lives on Github without any version at all.

What is nice and proper to do about it? What kind of records is it proper to leave in what kinds of files? Is there some support for the versioning process on Github? I need a primer for complete idiots, as I never have given any thought to the subject.

Last edited by Llama (2014-12-13 06:19:00)

yuvadm

Member

From: Tel Aviv-Jaffa, Israel

Registered: 2012-08-08

Posts: 102

Website

Re: Open source software versioning gudelines

Personally, I like to follow a process where even my small, one-time, projects are bundled in a way that other users can benefit from them.

Usually this means following a process where: all the code is stored on Github, there is a minimal README which explains how to build the repo and basic usage of the tool, a LICENSE file declaring how other users are free to use this code (usually GPL or BSD)

As for versioning, this is inherent in git by using tags. I like to tag the first usable version with v0.1 and take it from there if the project is ever to evolve:

$ git tag -a v0.1 -m "First usable version"
$ git push --tags

One the tags are pushed to github, they are referenced in the projects releases tab.

runical

Member

From: The Netherlands

Registered: 2012-03-03

Posts: 896

Re: Open source software versioning gudelines

If you really want to version, try adhering to the semantic version guidelines. Check here.

Last edited by runical (2014-12-13 11:04:56)

---

For all your makepkg signature checking troubles