This wiki is intended to host everything that do not need to be distributed with the codebase of agenda-libre-php.
It explains how the project is organised to achieve a collaborative development.
The project is following a successful git branching model where the master branch is the production-ready branch, while the develop branch is the testing branch.
if you are a user
You do not have the choice of which version to use, nor the choice of which version to install. The administrator of the instance you use has already decided it.
You might be interested in reading the user manual. Unfortunately, it does not exist yet ! Feel free to contact us if you feel confortable enough to write it. However, the web interface is self-documented (in french only for the moment) and this might be enough for you use it without being stuck.
if you are an administrator
You have the choice of which version to install :
As the administrator of the instance, you can choose to get the stable branch of this project. This stable branch has a version number, has a confortable lifetime, should be free of major bug, only gets security and major bugfixes. The documentation embedded in the distributed package is up to date (install guide, upgrade guide). If you recognize yourself in this administrator description, grab the master branch which is the stable branch.
If you're an edge administrator who like to stick to the last development branch, you can choose to get the develop branch of this project. This develop branch has a version number that ends with -dev suffix (ie: 3.1.0-dev). It should only contains finished features but could also have bugs. It is being updated frequently to add new features and fix bugs. The documentation embedded in the distributed package might not be up to date (install guide, upgrade guide). If you recognize yourself in this administrator description, you're an edge administrator (and have sort of edge users also) grab the develop branch which is the develop branch.
You might be interested in reading the administrator manual. Unfortunately, it does not exist yet ! Feel free to contact us if you feel confortable enough to write it. However, the web interface is self-documented (in french only for the moment) and this might be enough for you use it without being stuck.
if you are a tester
You have the choice of which version to test :
For end-to-end tests, you can choose to get the develop branch of this project. See above the description of this branch. Code developers will be happy to see someone testing the development branch before it is releases as a stable release.
If you want to help a developer and test his just-coded-but-unfinished feature, get the feature branch of the developer whose name is something like feature-. The developer will be glad to see someone else testing his brand new feature.
You might be interested in reading the tester manual. Unfortunately, there is no tester manual at the moment except the INSTALL guide and the UPGRADE guide (if you want to read one of them be careful to read the documents related to the version of the agenda-libre-php that you want to install or upgrade, prefer to document that were distributed with the codebase). Feel free to contact us if you feel confortable enough to write some more documentation for testers.
If you want to commit to the repository, please follow the convention otherwise your commit might be ignored or rejected.
A typical git commit message could be like the one above:
feat(map): replace Google map by OpenStreetMap mapReplace the Google map API and tiles by OpenStreetMap API and OpenLayers tiles.closes #17BREAKING CHANGE: you have to generate a new token in order to use OpenStreetMap API.
This commit is of type feature and is about the map scope (component). The title is short and clear while the body can be longer to give useful explanations. The commit closes issue #17 which can be a bug (for fixes) or a feature request (for features). The commit also brings a breaking change for anyone that is willing to apply this commit.
The repository contains a file named .git.commit.template that could help you writing good commit message at commit time. To enable this template from the root level of the repository, enter the following git commande line :