-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathguideline.html
120 lines (120 loc) · 6.21 KB
/
guideline.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
114
115
116
117
118
119
120
<!DOCTYPE HTML>
<html ng-app="fossnp">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link href="assets/css/bootstrap.css" rel="stylesheet">
<link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
<link href="assets/css/app.css" rel="stylesheet">
<link rel="icon"
type="image/icon"
href="assets/img/favicon.ico">
<title>FOSS Nepal</title>
</head>
<body>
<header class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<div class="container">
<a id="logo" href= "./index.html"> FOSS Nepal </a>
<nav>
<ul class="nav pull-right">
<li><a href="./guideline.html">Contribute @ FOSS Nepal!</a></li>
<li><a href="https://github.com/foss-np"> Visit the Github Repo </a></li>
</ul>
</nav>
</div>
</div>
</header>
<div class="center hero-unit">
<div class="page-header">
<h1>Guidelines for Contributors</small></h1>
</div>
<iframe src="http://ghbtns.com/github-btn.html?user=foss-np&type=follow&count=true&size=large" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="30"></iframe>
</div>
<div class="container">
<div class="row">
<div class="span3 bs-docs-sidebar">
<ul class="nav nav-list bs-docs-sidenav">
<li><a href="#general"><i class="icon-chevron-right"></i> General Guidelines </a></li>
<li><a href="#my"><i class="icon-chevron-right"></i> My Repo </a></li>
</ul>
</div>
<div class="span9">
<section id="general">
<div class="page-header">
<h1>General Guidelines</h1>
</div>
<h4> Please follow these general guidelines to keep the repo clean and managable </h4>
<ul>
<li><p class="text-info">Always be clear what you are doing</p></li>
<li><p class="text-info">Check your changes (commit) before pushing</p></li>
<li><p class="text-error">Don't ever force push that will create the chaos</p></li>
<ul>
<li>
i.e., never use <code>git push origin master --force</code> instead first <code>git pull origin master</code> and then after <code>git push origin master</code>
</li>
</ul>
<li><p class="muted">Commit short description</p></li>
<ul>
<li><p class="text-info">clearly mention summary of changes done</p></li>
<li><p class="text-info">Limit your description to 20-30 characters (**not** words)</p></li>
<li><p class="text-info">If you are referring to issue, tag the issue not like [fix #13]</p></li>
</ul>
<li><p class="muted">Commit long description</p></li>
<ul>
<li><p class="text-info">Its optional but there is no harm in having it.</p></li>
<li><p class="text-info">Please follow 70-75 char rule per line</p></li>
</ul>
<li><p class="text-info">Try to bundle you commit as the feature or bug fixes</p></li>
<li><p class="text-info">If you aren't sure how to bundle your changes (commits). Push it into new branch and create issue for some one to look over it!</p></li>
</ul>
</section>
<hr class="bs-docs-separator">
<section id="my">
<div class="page-header">
<h1> My Repo </h1>
</div>
<h4> Please follow these guidelines to maintain the status of your favourite repo </h4>
<ul>
<li><p class="muted"> Always create a clear, unambigious and easily understandable README file containing:</p></li>
<ul>
<li><p class = "text-info"> Project Title </p></li>
<li><p class = "text-info"> Project Statement </p> </li>
<li><p class = "text-info"> Project features </p> </li>
<li><p class = "text-info"> List of brances and for what purposes are they created (if any) </p> </li>
<li><p class = "text-info"> Hardware and Software Requirements </p> </li>
<li><p class = "text-info"> Information on how to run the project </p> </li>
<li><p class = "text-info"> Contact Information </p> </li>
<li><p class = "text-info"> License Information </p> </li>
</ul>
<li><p class="text-info"> Try to create the wiki about topics whenever possible</p></li>
<li><p class="text-info"> Maintain a screenshot folder about how your application looks after a successful run </p></li>
<li><p class="text-info"> Create a github page containing contact information and other project related information </p></li>
<li><p class="text-info"> Create a CONTRIBUTING file containing information regarding your project specific contribution criteria </p></li>
</ul>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<address>
<strong>FOSS Nepal Community</strong><br>
P. O. Box 19162<br>
Kathmandu, Nepal<br>
<abbr title="IRC Channel">IRC:</abbr> #foss-nepal on irc.freenode.net<br>
E-mail: <a href="mailto:info@fossnepal.org">info@fossnepal.org</a><br>
Website: <a href="https://fossnepal.herokuapp.com/" target="_blank">fossnepal.herokuapp.com</a><br>
Mailing List: <a href="https://groups.google.com/forum/#!forum/foss-nepal" target="_blank">groups.google.com/forum/#!forum/foss-nepal</a><br>
</address>
<p>Content is licensed under <a href="http://www.gnu.org/copyleft/fdl.html" target ="_blank">GNU Free Documentation License </a></p>
</div>
</footer>
<script
src="https://code.jquery.com/jquery-2.2.4.min.js"
integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44="
crossorigin="anonymous"></script>
<script src="assets/js/bootstrap.min.js" type="text/javascript"></script>
<script src="assets/js/angular.min.js" type="text/javascript"></script>
<script src="assets/js/app.js" type="text/javascript"></script>
</body>
</html>