From 992af0b9d77cb4fbac2c37ef8d5896042d67a2a3 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Wed, 22 Jul 2015 05:02:10 +0200 Subject: Doc: sync from Wiki, generate HTML Closes #291 Fixes #227 Modifications - HTML content: match the new Wiki structure - Makefile - generate a custom HTML sidebar - include the sidebar on all pages - infer and prepend page titles - handle relative links - add title metadata, e.g. Shaarli - Signed-off-by: VirtualTam --- doc/Development.html | 102 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 doc/Development.html (limited to 'doc/Development.html') diff --git a/doc/Development.html b/doc/Development.html new file mode 100644 index 00000000..1e33eff4 --- /dev/null +++ b/doc/Development.html @@ -0,0 +1,102 @@ + + + + + + + Shaarli - Development + + + + + + +

Development

Guidelines

Please have a look at the following pages:

Contributing to Shaarli
Static analysis - patches should try to stick to the PHP Standard Recommendations (PSR), especially: +
- PSR-1 - Basic Coding Standard
- PSR-2 - Coding Style Guide
Unit tests
GnuPG signature for tags/releases

Continuous integration tools

Local development

A Makefile is available to perform project-related operations:

Documentation - generate a local HTML copy of the GitHub wiki
Static analysis - check that the code is compliant to PHP conventions
Unit tests - ensure there are no regressions introduced by new commits

Automatic builds

Travis CI is a Continuous Integration build server, that runs a build:

each time a commit is merged to the mainline (master branch)
each time a Pull Request is submitted or updated

A build is composed of several jobs: one for each supported PHP version (see Server requirements).

Each build job:

updates Composer
installs 3rd-party test dependencies with Composer
runs Unit tests

After all jobs have finished, Travis returns the results to GitHub:

a status icon represents the result for the master branch:
Pull Requests are updated with the Travis result +
- Green: all tests have passed
- Red: some tests failed
- Orange: tests are pending

+ + -- cgit v1.2.3