[github/shaarli/Shaarli.git] / doc / Development.html

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <meta name="generator" content="pandoc">
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
  <title>Shaarli – Development</title>
  <style type="text/css">code{white-space: pre;}</style>
  <link rel="stylesheet" href="github-markdown.css">
  <!--[if lt IE 9]>
    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  <![endif]-->
</head>
<body>
<div id="local-sidebar">
<ul>
<li><a href="Home.html">Home</a></li>
<li>Setup
<ul>
<li><a href="Download-and-Installation.html">Download and Installation</a></li>
<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
<li><a href="Server-requirements.html">Server requirements</a></li>
<li><a href="Server-configuration.html">Server configuration</a></li>
<li><a href="Server-security.html">Server security</a></li>
<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
<li><a href="Plugins.html">Plugins</a></li>
</ul></li>
<li><a href="Docker.html">Docker</a></li>
<li><a href="Usage.html">Usage</a>
<ul>
<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
<li><a href="Firefox-share.html">Firefox share</a></li>
<li><a href="RSS-feeds.html">RSS feeds</a></li>
</ul></li>
<li>How To
<ul>
<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
<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>
<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
</ul></li>
<li><a href="Troubleshooting.html">Troubleshooting</a></li>
<li><a href="Development.html">Development</a>
<ul>
<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
<li><a href="Directory-structure.html">Directory structure</a></li>
<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
<li><a href="Plugin-System.html">Plugin System</a></li>
<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
<li><a href="Security.html">Security</a></li>
<li><a href="Static-analysis.html">Static analysis</a></li>
<li><a href="Theming.html">Theming</a></li>
<li><a href="Unit-tests.html">Unit tests</a></li>
</ul></li>
<li>About
<ul>
<li><a href="FAQ.html">FAQ</a></li>
<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
</ul></li>
</ul>
</div>
<h1 id="development">Development</h1>
<h2 id="guidelines">Guidelines</h2>
<p>Please have a look at the following pages:</p>
<ul>
<li><a href="https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md">Contributing to Shaarli</a><a href=".html"></a></li>
<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:
<ul>
<li><a href="http://www.php-fig.org/psr/psr-1/">PSR-1</a> - Basic Coding Standard<a href=".html"></a></li>
<li><a href="http://www.php-fig.org/psr/psr-2/">PSR-2</a> - Coding Style Guide<a href=".html"></a></li>
</ul></li>
<li><a href="Unit-tests.html">Unit tests</a></li>
<li><a href="GnuPG-signature.html">GnuPG signature</a> for tags/releases</li>
</ul>
<h2 id="continuous-integration-tools">Continuous integration tools</h2>
<h3 id="local-development">Local development</h3>
<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>
<ul>
<li>Documentation - generate a local HTML copy of the GitHub wiki</li>
<li><a href="Static-analysis.html">Static analysis</a> - check that the code is compliant to PHP conventions</li>
<li><a href="Unit-tests.html">Unit tests</a> - ensure there are no regressions introduced by new commits</li>
</ul>
<h3 id="automatic-builds">Automatic builds</h3>
<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>
<ul>
<li>each time a commit is merged to the mainline (<code>master</code> branch)</li>
<li>each time a Pull Request is submitted or updated</li>
</ul>
<p>A build is composed of several jobs: one for each supported PHP version (see <a href="Server-requirements.html">Server requirements</a>).</p>
<p>Each build job:</p>
<ul>
<li>updates Composer</li>
<li>installs 3rd-party test dependencies with Composer</li>
<li>runs <a href="Unit-tests.html">Unit tests</a></li>
</ul>
<p>After all jobs have finished, Travis returns the results to GitHub:</p>
<ul>
<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>
<li>Pull Requests are updated with the Travis result
<ul>
<li>Green: all tests have passed</li>
<li>Red: some tests failed</li>
<li>Orange: tests are pending</li>
</ul></li>
</ul>
</body>
</html>
Commit	Line	Data
992af0b9 V	1	<!DOCTYPE html>
	2	<html>
	3	<head>
	4	<meta charset="utf-8">
	5	<meta name="generator" content="pandoc">
	6	<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
5409ade2	7	<title>Shaarli – Development</title>
992af0b9	8	<style type="text/css">code{white-space: pre;}</style>
5409ade2	9	<link rel="stylesheet" href="github-markdown.css">
992af0b9	10	<!--[if lt IE 9]>
5409ade2	11	<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
992af0b9	12	<![endif]-->
992af0b9 V	13	</head>
	14	<body>
	15	<div id="local-sidebar">
	16	<ul>
	17	<li><a href="Home.html">Home</a></li>
fdf88d19	18	<li>Setup
992af0b9	19	<ul>
fdf88d19 A	20	<li><a href="Download-and-Installation.html">Download and Installation</a></li>
fdf88d19 A	21	<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
992af0b9 V	22	<li><a href="Server-requirements.html">Server requirements</a></li>
992af0b9 V	23	<li><a href="Server-configuration.html">Server configuration</a></li>
5409ade2	24	<li><a href="Server-security.html">Server security</a></li>
992af0b9	25	<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
08dcd8ea	26	<li><a href="Plugins.html">Plugins</a></li>
992af0b9	27	</ul></li>
5409ade2	28	<li><a href="Docker.html">Docker</a></li>
992af0b9 V	29	<li><a href="Usage.html">Usage</a>
	30	<ul>
	31	<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
5409ade2	32	<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
992af0b9 V	33	<li><a href="Firefox-share.html">Firefox share</a></li>
	34	<li><a href="RSS-feeds.html">RSS feeds</a></li>
	35	</ul></li>
	36	<li>How To
	37	<ul>
	38	<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
	39	<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>
5409ade2	40	<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
992af0b9	41	<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
6335a0fc	42	<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
992af0b9 V	43	</ul></li>
	44	<li><a href="Troubleshooting.html">Troubleshooting</a></li>
	45	<li><a href="Development.html">Development</a>
	46	<ul>
	47	<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
	48	<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
	49	<li><a href="Directory-structure.html">Directory structure</a></li>
	50	<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
	51	<li><a href="Plugin-System.html">Plugin System</a></li>
5409ade2	52	<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
992af0b9 V	53	<li><a href="Security.html">Security</a></li>
	54	<li><a href="Static-analysis.html">Static analysis</a></li>
	55	<li><a href="Theming.html">Theming</a></li>
	56	<li><a href="Unit-tests.html">Unit tests</a></li>
	57	</ul></li>
	58	<li>About
	59	<ul>
	60	<li><a href="FAQ.html">FAQ</a></li>
	61	<li><a href="Community-&-Related-software.html">Community & Related software</a></li>
992af0b9 V	62	</ul></li>
	63	</ul>
	64	</div>
	65	<h1 id="development">Development</h1>
	66	<h2 id="guidelines">Guidelines</h2>
	67	<p>Please have a look at the following pages:</p>
	68	<ul>
	69	<li><a href="https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md">Contributing to Shaarli</a><a href=".html"></a></li>
	70	<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:
	71	<ul>
	72	<li><a href="http://www.php-fig.org/psr/psr-1/">PSR-1</a> - Basic Coding Standard<a href=".html"></a></li>
	73	<li><a href="http://www.php-fig.org/psr/psr-2/">PSR-2</a> - Coding Style Guide<a href=".html"></a></li>
	74	</ul></li>
	75	<li><a href="Unit-tests.html">Unit tests</a></li>
	76	<li><a href="GnuPG-signature.html">GnuPG signature</a> for tags/releases</li>
	77	</ul>
	78	<h2 id="continuous-integration-tools">Continuous integration tools</h2>
	79	<h3 id="local-development">Local development</h3>
	80	<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>
	81	<ul>
	82	<li>Documentation - generate a local HTML copy of the GitHub wiki</li>
	83	<li><a href="Static-analysis.html">Static analysis</a> - check that the code is compliant to PHP conventions</li>
	84	<li><a href="Unit-tests.html">Unit tests</a> - ensure there are no regressions introduced by new commits</li>
	85	</ul>
	86	<h3 id="automatic-builds">Automatic builds</h3>
	87	<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>
	88	<ul>
	89	<li>each time a commit is merged to the mainline (<code>master</code> branch)</li>
	90	<li>each time a Pull Request is submitted or updated</li>
	91	</ul>
	92	<p>A build is composed of several jobs: one for each supported PHP version (see <a href="Server-requirements.html">Server requirements</a>).</p>
	93	<p>Each build job:</p>
	94	<ul>
	95	<li>updates Composer</li>
	96	<li>installs 3rd-party test dependencies with Composer</li>
	97	<li>runs <a href="Unit-tests.html">Unit tests</a></li>
	98	</ul>
	99	<p>After all jobs have finished, Travis returns the results to GitHub:</p>
	100	<ul>
5409ade2	101	<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>
992af0b9 V	102	<li>Pull Requests are updated with the Travis result
	103	<ul>
	104	<li>Green: all tests have passed</li>
	105	<li>Red: some tests failed</li>
	106	<li>Orange: tests are pending</li>
	107	</ul></li>
	108	</ul>
	109	</body>
	110	</html>