2 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
3 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6 <meta http-equiv=
"X-UA-Compatible" content=
"IE=edge">
7 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
10 <link rel=
"shortcut icon" href=
"../img/favicon.ico">
11 <title>Development guidelines - Shaarli Documentation
</title>
12 <link href='https://fonts.googleapis.com/css?family=Lato:
400,
700|Roboto+Slab:
400,
700|Inconsolata:
400,
700' rel='stylesheet' type='text/css'
>
14 <link rel=
"stylesheet" href=
"../css/theme.css" type=
"text/css" />
15 <link rel=
"stylesheet" href=
"../css/theme_extra.css" type=
"text/css" />
16 <link rel=
"stylesheet" href=
"../css/highlight.css">
17 <link href=
"../github-markdown.css" rel=
"stylesheet">
21 var mkdocs_page_name = "Development guidelines";
22 var mkdocs_page_input_path = "Development-guidelines.md";
23 var mkdocs_page_url = "/Development-guidelines/";
26 <script src=
"../js/jquery-2.1.1.min.js"></script>
27 <script src=
"../js/modernizr-2.8.3.min.js"></script>
28 <script type=
"text/javascript" src=
"../js/highlight.pack.js"></script>
32 <body class=
"wy-body-for-nav" role=
"document">
34 <div class=
"wy-grid-for-nav">
37 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side stickynav">
38 <div class=
"wy-side-nav-search">
39 <a href=
".." class=
"icon icon-home"> Shaarli Documentation
</a>
41 <form id =
"rtd-search-form" class=
"wy-form" action=
"../search.html" method=
"get">
42 <input type=
"text" name=
"q" placeholder=
"Search docs" />
47 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
51 <li class=
"toctree-l1">
53 <a class=
"" href=
"..">Home
</a>
56 <li class=
"toctree-l1">
58 <span class=
"caption-text">Setup
</span>
62 <a class=
"" href=
"../Download-and-Installation/">Download and Installation
</a>
66 <a class=
"" href=
"../Upgrade-and-migration/">Upgrade and migration
</a>
70 <a class=
"" href=
"../Server-requirements/">Server requirements
</a>
74 <a class=
"" href=
"../Server-configuration/">Server configuration
</a>
78 <a class=
"" href=
"../Server-security/">Server security
</a>
82 <a class=
"" href=
"../Shaarli-configuration/">Shaarli configuration
</a>
86 <a class=
"" href=
"../Plugins/">Plugins
</a>
91 <li class=
"toctree-l1">
93 <span class=
"caption-text">Docker
</span>
97 <a class=
"" href=
"../Docker-101/">Docker
101</a>
101 <a class=
"" href=
"../Shaarli-images/">Shaarli images
</a>
105 <a class=
"" href=
"../Reverse-proxy-configuration/">Reverse proxy configuration
</a>
109 <a class=
"" href=
"../Docker-resources/">Docker resources
</a>
114 <li class=
"toctree-l1">
116 <span class=
"caption-text">Usage
</span>
120 <a class=
"" href=
"../Features/">Features
</a>
124 <a class=
"" href=
"../Bookmarklet/">Bookmarklet
</a>
128 <a class=
"" href=
"../Browsing-and-searching/">Browsing and searching
</a>
132 <a class=
"" href=
"../Firefox-share/">Firefox share
</a>
136 <a class=
"" href=
"../RSS-feeds/">RSS feeds
</a>
140 <a class=
"" href=
"../REST-API/">REST API
</a>
145 <li class=
"toctree-l1">
147 <span class=
"caption-text">How To
</span>
151 <a class=
"" href=
"../Backup,-restore,-import-and-export/">Backup, restore, import and export
</a>
155 <a class=
"" href=
"../Various-hacks/">Various hacks
</a>
160 <li class=
"toctree-l1">
162 <a class=
"" href=
"../Troubleshooting/">Troubleshooting
</a>
165 <li class=
"toctree-l1">
167 <span class=
"caption-text">Development
</span>
169 <li class=
" current">
171 <a class=
"current" href=
"./">Development guidelines
</a>
174 <li class=
"toctree-l3"><a href=
"#development-guidelines">Development guidelines
</a></li>
181 <a class=
"" href=
"../Continuous-integration-tools/">Continuous integration tools
</a>
185 <a class=
"" href=
"../GnuPG-signature/">GnuPG signature
</a>
189 <a class=
"" href=
"../Coding-guidelines/">Coding guidelines
</a>
193 <a class=
"" href=
"../Directory-structure/">Directory structure
</a>
197 <a class=
"" href=
"../3rd-party-libraries/">3rd party libraries
</a>
201 <a class=
"" href=
"../Plugin-System/">Plugin System
</a>
205 <a class=
"" href=
"../Release-Shaarli/">Release Shaarli
</a>
209 <a class=
"" href=
"../Versioning-and-Branches/">Versioning and Branches
</a>
213 <a class=
"" href=
"../Security/">Security
</a>
217 <a class=
"" href=
"../Static-analysis/">Static analysis
</a>
221 <a class=
"" href=
"../Theming/">Theming
</a>
225 <a class=
"" href=
"../Unit-tests/">Unit tests
</a>
230 <li class=
"toctree-l1">
232 <span class=
"caption-text">About
</span>
236 <a class=
"" href=
"../FAQ/">FAQ
</a>
240 <a class=
"" href=
"../Community-&-Related-software/">Community & Related software
</a>
250 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
253 <nav class=
"wy-nav-top" role=
"navigation" aria-label=
"top navigation">
254 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
255 <a href=
"..">Shaarli Documentation
</a>
259 <div class=
"wy-nav-content">
260 <div class=
"rst-content">
261 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
262 <ul class=
"wy-breadcrumbs">
263 <li><a href=
"..">Docs
</a> »</li>
267 <li>Development
»</li>
271 <li>Development guidelines
</li>
272 <li class=
"wy-breadcrumbs-aside">
274 <a href=
"https://github.com/shaarli/Shaarli/edit/master/docs/Development-guidelines.md"
275 class=
"icon icon-github"> Edit on GitHub
</a>
282 <div class=
"section">
284 <h2 id=
"development-guidelines">Development guidelines
</h2>
285 <p>Please have a look at the following pages:
286 -
<a href=
"https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md">Contributing to Shaarli
</a>
287 -
<a href=
"../Static analysis">Static analysis
</a> - patches should try to stick to the
<a href=
"http://www.php-fig.org/psr/">PHP Standard Recommendations
</a> (PSR), especially:
288 -
<a href=
"http://www.php-fig.org/psr/psr-1/">PSR-
1</a> - Basic Coding Standard
289 -
<a href=
"http://www.php-fig.org/psr/psr-2/">PSR-
2</a> - Coding Style Guide
290 -
<a href=
"../Unit tests">Unit tests
</a>
291 -
<a href=
"../GnuPG signature">GnuPG signature
</a> for tags/releases
</p>
297 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
299 <a href=
"../Continuous-integration-tools/" class=
"btn btn-neutral float-right" title=
"Continuous integration tools">Next
<span class=
"icon icon-circle-arrow-right"></span></a>
302 <a href=
"../Troubleshooting/" class=
"btn btn-neutral" title=
"Troubleshooting"><span class=
"icon icon-circle-arrow-left"></span> Previous
</a>
309 <div role=
"contentinfo">
310 <!-- Copyright etc -->
314 Built with
<a href=
"http://www.mkdocs.org">MkDocs
</a> using a
<a href=
"https://github.com/snide/sphinx_rtd_theme">theme
</a> provided by
<a href=
"https://readthedocs.org">Read the Docs
</a>.
324 <div class=
"rst-versions" role=
"note" style=
"cursor: pointer">
325 <span class=
"rst-current-version" data-toggle=
"rst-current-version">
327 <a href=
"https://github.com/shaarli/Shaarli" class=
"fa fa-github" style=
"float: left; color: #fcfcfc"> GitHub
</a>
330 <span><a href=
"../Troubleshooting/" style=
"color: #fcfcfc;">« Previous
</a></span>
333 <span style=
"margin-left: 15px"><a href=
"../Continuous-integration-tools/" style=
"color: #fcfcfc">Next
»</a></span>
337 <script src=
"../js/theme.js"></script>