/
contribute.html
113 lines (99 loc) · 3.71 KB
/
contribute.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./assets/css/combined.css">
<link rel="shortcut icon" href="./favicon.ico" />
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
var path = './';
</script>
<script src="./assets/js/combined.js"></script>
<title>Contribute - FuelPHP Documentation</title>
</head>
<body>
<div id="container">
<header id="header">
<div class="table">
<h1>
<strong>FuelPHP, a PHP 5.3 Framework</strong>
Documentation
</h1>
<form id="google_search">
<p>
<span id="search_clear"> </span>
<input type="submit" name="search_submit" id="search_submit" value="search" />
<input type="text" value="" id="search_input" name="search_input" />
</p>
</form>
</div>
<nav>
<div class="clear"></div>
</nav>
<a href="#" id="toc_handle">table of contents</a>
<div class="clear"></div>
</header>
<div id="cse">
<div id="cse_point"></div>
<div id="cse_content"></div>
</div>
<div id="main">
<h2>Contribute</h2>
<h3 id="introduction">Introduction</h3>
<p>
Fuel is a community driven framework and is open for contributions from anyone who feels they
can improve it or add a feature that will bring the framework to a higher level. There
are multiple forms in which this can be achieved. From writing tutorials, writing and
releasing packages, to contributing to the official parts of Fuel (Core, Orm, Docs, etc..).
</p>
<h3 id="fixing_bugs">Fixing Bugs</h3>
<p>
When you encounter a bug or see one in the issues list that you can or have resolved,
and you want to contribute it back to the framework. Use GitHub to send a pull request.
Depending on which version you are running the branch you pull on. Follow the next couple
of steps to when you request a pull:
</p>
<ul>
<li>
<strong>Is my current version still supported?</strong><br/>
If not, upgrade to a supported version and see if the bug is still exists.
</li>
<li>
<strong>Checkout your version on your local repository</strong><br/>
<code class="cli">$ git checkout -b 1.2/develop origin/1.2/develop</code> (bugfix branch for the current release )
</li>
<li>
<strong>Fix the bug and commit it in your local repository</strong><br/>
Use a descriptive and understandable commit message
<code class="cli">$ git commit -m "This is my awesome description."</code>
</li>
<li>
<strong>Push it to your GitHub account</strong><br/>
<code class="cli">$ git push</code>
</li>
<li>
<strong>Request the pull</strong><br/>
Request the pull on the same branch as you are on (or you based your branch off).
Use the "update commit range" interface to direct you request to the correct branch.
Pull requests are only accepted on the current release bugfix branch (1.2/develop) or the next release development branch (1.3/develop).
</li>
<li>
<strong>Wait for your moment of fame</strong><br/>
As soon as your request is merged you'll be part of the contributors list of Fame.
</li>
</ul>
<h3 id="enhancements">Non-bug contributions</h3>
<p>
Non-bug contributions are new features, optimizations and all other alterations. All of these request must be made on the
latest development branch. So pull the 1.3/develop branch, make the changes and request a pull.
</p>
</div>
<footer>
<p>
© FuelPHP Development Team 2010-2012 - <a href="http://fuelphp.com">FuelPHP</a> is released under the MIT license.
</p>
</footer>
</div>
</body>
</html>