Conventions for Mapbender¶
variable names / way of coding
trans convention - where to put translation
document the x steps on the way to a new functionality
define the topic
create a ticket
create a workflow
discuss the workflow with the core team and find a final solution
do the programming
documentation in mapbender-documentation –> rst
close the ticket
where to put a module/element
naming vor files (referred to symfony convention)
Git branch conventions¶
We follow the Git Flow branching model (Read more about it in the original document describing it). Basically that boils down to having at least two branches:
develop - for the daily work, always has the latest merged commits, and is equal to or ahead of the latest release
master - only changes on new releases (right now and until the 3.0.1 release, some of our repositories don’t have a master branch but will get one then again)
Furthermore there might be more branches, which must always be namespaced:
feature/<name> - Used for developing new features (feature/printservice)
hotfix/<name> - Used for making hot fixes for releases (hotfix/bug_123)
release/<name> - Used for preparing releases, very short-lived (release/3.0.1)
Some Linux distributions have a package called git-flow which will provide easy git command shortcuts to use the merge/branch model of Git Flow without having to do everything by yourself (which is still possible and you should always know how Git Flow uses plain git to achieve things).
What to keep in mind, when you create a layout
where to put the css
where to put the twig
where to put the images / should be possible to easy switch an image collection an get other buttons
conventions to put the files? Groß-Kleinschreibung/welche Übersetzungen werden generell gepflegt? en/de weitere?
also have a look at Translation in Mapbender <../translation.rst>
Issues (bugs and features) are administrated in the mapbender-repository at:
We create a milestone for every version of Mapbender:
There are some rules you should keep in mind:
write understandable tickets!!
write your title so that the issue is already described in the title:
Browser - Backend/Frontend - element - issue
like: Firefox - Frontend - layertree - option visible is not handled in frontend
write comments with all necessary information: * for bugs: describe step by step how the error can be reproduced * for features: describe feature and functionality
when you create a new ticket do not assign it to a milestone or developer, if you are not sure
add labels to your ticket * bug - describes a bug that orrurs in a special version of Mapbender (add info about the version) * feature - new feature * enhancement - stands for feature enhancement * wip - work in progress
when you work on a ticket or close it please assign a user and milestone
when you close a ticket, please:
add a comment in the ticket and refer to the commit,
refer to the documentation at http://doc.mapbender.org or a demo if possibile.
The Mapbender version is defined by a four digit numbering system, seperated by dots.
The first digit is constant and represents the Mapbender software cycle.
The second digit describes all new features and major changes in Mapbender, with the highest difficulty level of a update process.
The third digit describes new features and minor changes, which can be easily updated.
The fourth digit represents only bugfixes and micro changes.
Increase a digit means always a reset for all digits before. For example - 188.8.131.52 -> 184.108.40.206
This numbering system started with Mapbender version 220.127.116.11
check whether all tickets are done
build a build - check documentation -> How to build a new Mapbender build
update Roadmap and milestones
write release mail (mapbender-user / mapbender-dev / major releases osgeo-announce)
How to build a new Mapbender build¶
Resolve and close all tickets for the relevant milestone: https://github.com/mapbender/mapbender/milestones
Update Changelog.md for mapbender-starter, mapbender, owsproxy, fom.
Update version number in parameters.yml.dist and push
Update version number in composer.json
Tagging: Tag at Github. You have nice capabilities for creating good tags and descriptions.
Create Pull-request to merge release branch into master
Clone the source-code from the release branch
git clone -b release/3.0.6 email@example.com:mapbender/mapbender-starter
Change to the directory
Change to the directory
Generate the docs
Create the ZIP/Tar.gz
bin/composer build bin/composer build zip
Move TAR.GZ and ZIP file to /sites/www.mapbender.org/builds
Update symbolic links (“version”.zip and “version”.tar.gz and current.tar.gz and current.zip)
Move current doc to docs.mapbender.org (get it from web/docs. Remove the api folder).
Write release mail to mapbender-user and mapbender-dev
Only for major releases write release mail to firstname.lastname@example.org (see also http://www.osgeo.org/content/news/submit_news.html)
Twitter on https://twitter.com/mapbender
Create a version based installation http://3053.mapbender.org