libqgit2/src/Mainpage.dox

0001 /** @mainpage The libqgit2 API Reference
0002
0003 <p><b>
0004 Overview |
0005 @ref components |
0006 @ref development |
0007 @ref search
0008 </b></p>
0009
0010 This is a quick description of libqgit2.
0011
0012 Official repository is <a href="https://projects.kde.org/projects/playground/libs/libqgit2">on KDE Projects</a>.
0013
0014 Feel free to use, hack, modify and report issues.
0015 You will find in the Related Pages of this documentations a Todo list.
0016 It is a good starting point to join =).
0017
0018 Currently updated to libgit2 0.19.0.
0019
0020 The library is still a simple wrapper of libgit2 and does not yet implement Git porcelain functions.
0021
0022 I'm trying to uniform the documentation, but it can still be lacking or incomplete.
0023
0024 Library is versioned with a MAJOR.MINOR.REV schema.
0025 My versioning policy is the following:
0026
0027 - Every change in internal code, which is transparent to the user increments REV (e.g. 0.1.0 -> 0.1.1)
0028 - Every API addition or change increments MINOR (e.g. 0.1.0 -> 0.2.0)
0029 - Every time the library reaches a very big milestone MAJOR increments (e.g. 0.1.0 -> 1.0.0)
0030
0031 This means that as soon as the library will be ready to be used in production (and libgit2 does no more break the API),
0032 this library will hopefully reach version 1.0.0 and remain in version 1.x.y until we will write it again from scratch.
0033 Feel free to disagree with this policy but please do not break it.
0034 If you think I'm committing a crime versioning with just MINOR and REV let me (lgiordani) know, I'm always ready to discuss my choices.
0035
0036 I consider the API NOT stable until it reaches version 1.0.0.
0037
0038 @authors
0039 Digging in the Git repository log I find the following (in order of appearance):
0040 - Laszlo Papp (lpapp)
0041 - Nils Fenner (fenner)
0042 - Robin Pedersen (rpedersen)
0043 - Miquel Canes Gonzalez (canesgonzalez)
0044 - Orgad Shaneh (orgads)
0045 - Leonardo Giordani (lgiordani)
0046
0047 I hope I didn't forget anyone.
0048
0049 Current maintainer is Laszlo Papp.
0050 For any question feel free to contact Leonardo Giordani, you can find contact information on the KDE Projects page
0051 */