140 lines
5.2 KiB
HTML
140 lines
5.2 KiB
HTML
<!DOCTYPE html>
|
|
<html class="no-js" id="top">
|
|
<head>
|
|
<title>ProxyManager - Contributing</title>
|
|
|
|
<meta name="description" content="A proxyManager write in php" />
|
|
<meta name="keywords" content="ProxyManager, proxy, manager, ocramius, Marco Pivetta, php, contributing" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
|
|
<link href='http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,300,400,600' rel='stylesheet' type='text/css'>
|
|
<link href="css/styles.css" rel="stylesheet" />
|
|
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/default.min.css">
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
<link rel="shortcut icon" href="favicon.ico">
|
|
</head>
|
|
<body>
|
|
|
|
<header class="site-header">
|
|
<div class="container">
|
|
<h1><a href="index.html"><img alt="ProxyManager" src="img/block.png" /></a></h1>
|
|
|
|
<nav class="main-nav" role="navigation">
|
|
<ul>
|
|
<li><a href="https://github.com/Ocramius/ProxyManager" target="_blank">Github</a>
|
|
<div class="bcms-clearfix"></div>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</header>
|
|
<main role="main">
|
|
<section class="component-content">
|
|
|
|
<div class="component-demo" id="live-demo">
|
|
<div class="container">
|
|
<div class="main-wrapper" style="text-align: right">
|
|
<iframe src="http://ghbtns.com/github-btn.html?user=ocramius&repo=ProxyManager&type=fork&count=true&size=large"
|
|
allowtransparency="true" frameborder="0" scrolling="0" width="310" height="40"></iframe>
|
|
|
|
<iframe src="http://ghbtns.com/github-btn.html?user=ocramius&repo=ProxyManager&type=watch&count=true&size=large"
|
|
allowtransparency="true" frameborder="0" scrolling="0" width="200" height="40"></iframe>
|
|
|
|
</div>
|
|
<div class="bcms-clearfix bcms-clearfix"></div>
|
|
</div>
|
|
</div>
|
|
<div class="component-info">
|
|
<div class="container">
|
|
<aside class="sidebar">
|
|
<nav class="spy-nav">
|
|
<ul>
|
|
<li><a href="index.html">Intro</a></li>
|
|
<li><a href="virtual-proxy.html">Virtual Proxy</a></li>
|
|
<li><a href="null-object.html">Null Objects</a></li>
|
|
<li><a href="ghost-object.html">Ghost Objects</a></li>
|
|
<li><a href="remote-object.html">Remote Object</a></li>
|
|
<li><a href="contributing.html">Contributing</a></li>
|
|
<li><a href="credits.html">Credits</a></li>
|
|
<li><a href="copyright.html">Copyright</a></li>
|
|
</ul>
|
|
</nav>
|
|
<div class="bcms-clearfix bcms-clearfix"></div>
|
|
<a class="btn btn-action btn-full download-component"
|
|
href="download.html">Download</a>
|
|
<div class="bcms-clearfix"></div>
|
|
</aside>
|
|
|
|
<div class="content">
|
|
<div class="bcms-clearfix"></div>
|
|
<h3 class="section-title">Contributing</h3>
|
|
|
|
<ul>
|
|
<li>Coding standard for the project is <a href="https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md" target-"_blank">PSR-2</a></li>
|
|
<li>The project will follow strict <a href="http://www.slideshare.net/guilhermeblanco/object-calisthenics-applied-to-php" target-"_blank">object calisthenics</a></li>
|
|
<li>Any contribution must provide tests for additional introduced conditions</li>
|
|
<li>Any un-confirmed issue needs a failing test case before being accepted</li>
|
|
<li>Pull requests must be sent from a new hotfix/feature branch, not from master.</li>
|
|
</ul>
|
|
|
|
|
|
<hr />
|
|
|
|
<h3 class="section-title">Installation</h3>
|
|
|
|
<p>To install the project and run the tests, you need to clone it first:</p>
|
|
|
|
<pre>
|
|
<code class="sh">
|
|
$ git clone git://github.com/Ocramius/ProxyManager.git
|
|
</code>
|
|
</pre>
|
|
|
|
<p>You will then need to run a composer installation:</p>
|
|
|
|
<pre>
|
|
<code class="sh">
|
|
$ cd ProxyManager
|
|
$ curl -s https://getcomposer.org/installer | php
|
|
$ php composer.phar update
|
|
</code>
|
|
</pre>
|
|
|
|
<hr />
|
|
|
|
<h3 class="section-title">Testing</h3>
|
|
|
|
<p>The PHPUnit version to be used is the one installed as a dev- dependency via composer:</p>
|
|
|
|
<pre>
|
|
<code class="sh">
|
|
$ ./vendor/bin/phpunit
|
|
</code>
|
|
</pre>
|
|
|
|
<p>Accepted coverage for new contributions is 80%. Any contribution not satisfying this requirement won't be merged.</p>
|
|
|
|
</main>
|
|
|
|
<footer class="site-footer" role="contentinfo">
|
|
<div class="container">
|
|
<div class="footer-logos">
|
|
<ul>
|
|
<li><a href="index.html">Intro</a> | </li>
|
|
<li><a href="virtual-proxy.html">Virtual Proxy</a> | </li>
|
|
<li><a href="null-object.html">Null Objects</a> | </li>
|
|
<li><a href="ghost-object.html">Ghost Objects</a> | </li>
|
|
<li><a href="remote-object.html">Remote Object</a> | </li>
|
|
<li><a href="contributing.html">Contributing</a> | </li>
|
|
<li><a href="credits.html">Credits</a> | </li>
|
|
<li><a href="copyright.html">Copyright</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="bcms-clearfix"></div>
|
|
</footer>
|
|
<div class="bcms-clearfix"></div>
|
|
</body>
|
|
</html>
|