992af0b9d7
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 - <Page Name> Signed-off-by: VirtualTam <virtualtam@flibidi.net>
1.9 KiB
1.9 KiB
#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:
- 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 (
masterbranch) - 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
masterbranch: - Pull Requests are updated with the Travis result
- Green: all tests have passed
- Red: some tests failed
- Orange: tests are pending