5 <meta name=
"generator" content=
"pandoc">
6 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli – Development
</title>
8 <style type=
"text/css">code{white-space: pre;}
</style>
9 <link rel=
"stylesheet" href=
"github-markdown.css">
11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
15 <div id=
"local-sidebar">
17 <li><a href=
"Home.html">Home
</a></li>
20 <li><a href=
"Download-and-Installation.html">Download and Installation
</a></li>
21 <li><a href=
"Upgrade-and-migration.html">Upgrade and migration
</a></li>
22 <li><a href=
"Server-requirements.html">Server requirements
</a></li>
23 <li><a href=
"Server-configuration.html">Server configuration
</a></li>
24 <li><a href=
"Server-security.html">Server security
</a></li>
25 <li><a href=
"Shaarli-configuration.html">Shaarli configuration
</a></li>
26 <li><a href=
"Plugins.html">Plugins
</a></li>
28 <li><a href=
"Docker.html">Docker
</a></li>
29 <li><a href=
"Usage.html">Usage
</a>
31 <li><a href=
"Sharing-button.html">Sharing button
</a> (bookmarklet)
</li>
32 <li><a href=
"Browsing-and-Searching.html">Browsing and Searching
</a></li>
33 <li><a href=
"Firefox-share.html">Firefox share
</a></li>
34 <li><a href=
"RSS-feeds.html">RSS feeds
</a></li>
35 <li><a href=
"REST-API.html">REST API
</a></li>
39 <li><a href=
"Backup,-restore,-import-and-export.html">Backup, restore, import and export
</a></li>
40 <li><a href=
"Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally
</a></li>
41 <li><a href=
"Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)
</a></li>
42 <li><a href=
"Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list
</a></li>
43 <li><a href=
"Datastore-hacks.html">Datastore hacks
</a></li>
45 <li><a href=
"Troubleshooting.html">Troubleshooting
</a></li>
46 <li><a href=
"Development.html">Development
</a>
48 <li><a href=
"GnuPG-signature.html">GnuPG signature
</a></li>
49 <li><a href=
"Coding-guidelines.html">Coding guidelines
</a></li>
50 <li><a href=
"Directory-structure.html">Directory structure
</a></li>
51 <li><a href=
"3rd-party-libraries.html">3rd party libraries
</a></li>
52 <li><a href=
"Plugin-System.html">Plugin System
</a></li>
53 <li><a href=
"Release-Shaarli.html">Release Shaarli
</a></li>
54 <li><a href=
"Versioning-and-Branches.html">Versioning and Branches
</a></li>
55 <li><a href=
"Security.html">Security
</a></li>
56 <li><a href=
"Static-analysis.html">Static analysis
</a></li>
57 <li><a href=
"Theming.html">Theming
</a></li>
58 <li><a href=
"Unit-tests.html">Unit tests
</a></li>
62 <li><a href=
"FAQ.html">FAQ
</a></li>
63 <li><a href=
"Community-&-Related-software.html">Community
& Related software
</a></li>
67 <h1 id=
"development">Development
</h1>
68 <h2 id=
"guidelines">Guidelines
</h2>
69 <p>Please have a look at the following pages:
</p>
71 <li><a href=
"https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md">Contributing to Shaarli
</a><a href=
".html"></a></li>
72 <li><a href=
"Static-analysis.html">Static analysis
</a> - patches should try to stick to the
<a href=
"http://www.php-fig.org/psr/">PHP Standard Recommendations
</a> (PSR), especially:
74 <li><a href=
"http://www.php-fig.org/psr/psr-1/">PSR-
1</a> - Basic Coding Standard
<a href=
".html"></a></li>
75 <li><a href=
"http://www.php-fig.org/psr/psr-2/">PSR-
2</a> - Coding Style Guide
<a href=
".html"></a></li>
77 <li><a href=
"Unit-tests.html">Unit tests
</a></li>
78 <li><a href=
"GnuPG-signature.html">GnuPG signature
</a> for tags/releases
</li>
80 <h2 id=
"continuous-integration-tools">Continuous integration tools
</h2>
81 <h3 id=
"local-development">Local development
</h3>
82 <p>A
<a href=
"https://github.com/shaarli/Shaarli/blob/master/Makefile"><code>Makefile
</code></a> is available to perform project-related operations:
<a href=
".html"></a></p>
84 <li>Documentation - generate a local HTML copy of the GitHub wiki
</li>
85 <li><a href=
"Static-analysis.html">Static analysis
</a> - check that the code is compliant to PHP conventions
</li>
86 <li><a href=
"Unit-tests.html">Unit tests
</a> - ensure there are no regressions introduced by new commits
</li>
88 <h3 id=
"automatic-builds">Automatic builds
</h3>
89 <p><a href=
"http://docs.travis-ci.com/">Travis CI
</a> is a Continuous Integration build server, that runs a build:
<a href=
".html"></a></p>
91 <li>each time a commit is merged to the mainline (
<code>master
</code> branch)
</li>
92 <li>each time a Pull Request is submitted or updated
</li>
94 <p>A build is composed of several jobs: one for each supported PHP version (see
<a href=
"Server-requirements.html">Server requirements
</a>).
</p>
95 <p>Each build job:
</p>
97 <li>updates Composer
</li>
98 <li>installs
3rd-party test dependencies with Composer
</li>
99 <li>runs
<a href=
"Unit-tests.html">Unit tests
</a></li>
101 <p>After all jobs have finished, Travis returns the results to GitHub:
</p>
103 <li>a status icon represents the result for the
<code>master
</code> branch:
<a href=
"(https://api.travis-ci.org/shaarli/Shaarli.svg)%5D(https://travis-ci.org/shaarli/Shaarli).html"><img src=
"https://travis-ci.org/shaarli/Shaarli" alt=
"(https://api.travis-ci.org/shaarli/Shaarli.svg)" /></a></li>
104 <li>Pull Requests are updated with the Travis result
106 <li>Green: all tests have passed
</li>
107 <li>Red: some tests failed
</li>
108 <li>Orange: tests are pending
</li>