docs/contribute.html at 1.1/develop · rclanan/docs · GitHub

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
<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">
	<title>Classes - Contribute</title>
	<link href="./assets/css/main.css" media="screen" rel="stylesheet" />
	<script type="text/javascript" src="./assets/js/jquery-1.4.4.min.js"></script>
	<script type="text/javascript" src="./assets/js/nav.js"></script>
	<script type="text/javascript" src="./assets/js/highlight.pack.js"></script>
	<script type="text/javascript">
		$(function() {
			show_nav('basic', './');
		});
	</script>
</head>
<body>

	<header>
		<h1>Fuel Documentation</h1>
	</header>

	<div id="main-nav"></div>

	<section id="content">
		<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 you local repo</strong><br/>
				<code class="cli">$ git checkout -b 1.1/develop origin/1.1/develop</code>
				or
				<code class="cli">$ git checkout -b 1.0/develop origin/1.0/develop</code>
			</li>
			<li>
				<strong>Fix the bug and commit it in you local repo</strong><br/>
				Use an descriptive and understandable commit message
				<code class="cli">$ git commit -m "This is my awesome description."</code>
			</li>
			<li>
				<strong>Push it to you 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).
				A 1.0/develop branch request pulls on 1.0/develop, 1.1/develop on 1.1/develop and so on.
				Use the "update commit range" interface to direct you request to the correct branch.
			</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 latest version's dev branch, make the changes and request a pull.
		</p>

	</section>

	<section id="footer">
		<p>
			<a href="http://fuelphp.com">Fuel</a> is released under the MIT license.<br />
			&copy; 2010 - 2011 Fuel Development Team
		</p>
	</section>

</body>
</html>