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