forked from mermaid-js/mermaid
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCONTRIBUTING.html
253 lines (223 loc) · 11.5 KB
/
CONTRIBUTING.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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Article page</title>
<meta name="description" content="">
<meta name="author" content="ink, cookbook, recipes">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="mobile-web-app-capable" content="yes">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0">
<!-- Place favicon.ico and apple-touch-icon(s) here -->
<link rel="shortcut icon" href="http://cdn.ink.sapo.pt/3.1.1/img/favicon.ico">
<link rel="apple-touch-icon" href="http://cdn.ink.sapo.pt/3.1.1/img/touch-icon-iphone.png">
<link rel="apple-touch-icon" sizes="76x76" href="http://cdn.ink.sapo.pt/3.1.1/img/touch-icon-ipad.png">
<link rel="apple-touch-icon" sizes="120x120" href="http://cdn.ink.sapo.pt/3.1.1/img/touch-icon-iphone-retina.png">
<link rel="apple-touch-icon" sizes="152x152" href="http://cdn.ink.sapo.pt/3.1.1/img/touch-icon-ipad-retina.png">
<link rel="apple-touch-startup-image" href="http://cdn.ink.sapo.pt/3.1.1/img/splash.320x460.png" media="screen and (min-device-width: 200px) and (max-device-width: 320px) and (orientation:portrait)">
<link rel="apple-touch-startup-image" href="http://cdn.ink.sapo.pt/3.1.1/img/splash.768x1004.png" media="screen and (min-device-width: 481px) and (max-device-width: 1024px) and (orientation:portrait)">
<link rel="apple-touch-startup-image" href="http://cdn.ink.sapo.pt/3.1.1/img/splash.1024x748.png" media="screen and (min-device-width: 481px) and (max-device-width: 1024px) and (orientation:landscape)">
<!-- load Ink's css from the cdn -->
<link rel="stylesheet" type="text/css" href="http://cdn.ink.sapo.pt/3.1.1/css/ink-flex.min.css">
<link rel="stylesheet" type="text/css" href="http://cdn.ink.sapo.pt/3.1.1/css/font-awesome.min.css">
<!-- load Ink's css for IE8 -->
<!--[if lt IE 9 ]>
<link rel="stylesheet" href="http://cdn.ink.sapo.pt/3.1.1/css/ink-ie.min.css" type="text/css" media="screen" title="no title" charset="utf-8">
<![endif]-->
<!-- test browser flexbox support and load legacy grid if unsupported -->
<script type="text/javascript" src="http://cdn.ink.sapo.pt/3.1.1/js/modernizr.js"></script>
<script type="text/javascript">
Modernizr.load({
test: Modernizr.flexbox,
nope : 'http://cdn.ink.sapo.pt/3.1.1/css/ink-legacy.min.css'
});
</script>
<!-- load Ink's javascript files from the cdn -->
<script type="text/javascript" src="http://cdn.ink.sapo.pt/3.1.1/js/holder.js"></script>
<script type="text/javascript" src="http://cdn.ink.sapo.pt/3.1.1/js/ink-all.min.js"></script>
<script type="text/javascript" src="http://cdn.ink.sapo.pt/3.1.1/js/autoload.js"></script>
<script type="text/javascript" src="https://cdn.rawgit.com/knsv/mermaid/0.3.0/dist/mermaid.full.js"></script>
<style type="text/css">
body {
background: #ededed;
}
header h1 small:before {
content: "|";
margin: 0 0.5em;
font-size: 1.6em;
}
article header{
padding: 0;
overflow: hidden;
}
article footer {
background: none;
}
article {
padding-bottom: 2em;
border-bottom: 1px solid #ccc;
}
.date {
float: right;
}
summary {
font-weight: 700;
line-height: 1.5;
}
footer {
background: #ccc;
}
</style>
<script>
Ink.requireModules(['Ink.Dom.Loaded_1'], function (DomLoaded) {
DomLoaded.run(function(){
var elements = document.querySelectorAll ('article h1,h2');
var i;
var sections = document.getElementById('sections');
for(i=0;i<elements.length;i++){
var e = elements[i];
sections.innerHTML = sections.innerHTML + '<li><a href="#'+e.id+'">'+e.innerText+'</a></li>';
//$("#sections").append('<li><a href="http://www.idg.se">'+$e.text()+'</a></li>');
}
Ink.requireModules( ['Ink.UI.Sticky_1'], function( Sticky ){
new Sticky('#sidenav')
});
});
});
</script>
</head>
<body>
<div class="ink-grid">
<!--[if lte IE 9 ]>
<div class="ink-alert basic" role="alert">
<button class="ink-dismiss">×</button>
<p>
<strong>You are using an outdated Internet Explorer version.</strong>
Please <a href="http://browsehappy.com/">upgrade to a modern browser</a> to improve your web experience.
</p>
</div>
-->
<!-- Add your site or application content here -->
<header class="clearfix vertical-padding">
<h1 class="logo xlarge-push-left large-push-left">
mermaid<small>Diagrams and flowcharts from textsimilar to markdown</small>
</h1>
<nav class="ink-navigation xlarge-push-right large-push-right half-top-space">
<ul class="menu horizontal black">
<li class="active"><a href="CONTRIBUTING.html">CONTRIBUTING</a></li>
<li><a href="README.html">README</a></li>
<li><a href="index.html">index</a></li>
<li><a href="sequenceDiagram.html">sequenceDiagram</a></li>
</ul>
</nav>
</header>
<section class="column-group gutters article">
<div class="xlarge-70 large-70 medium-60 small-100 tiny-100">
<article>
<h1 id="how-to-contribute">How to contribute</h1>
<p>Great that you want to be involved in this project! Contributing is fun and contributions are GREAT! :)</p>
<p>This page is currently a starting point is not so rigorous to start with.</p>
<p>Some important guidlines:</p>
<ul>
<li>The work will be organized using the issues list<ul>
<li>In the list there will be the bugs/enhancements etc we are working with in the project</li>
<li>There will be milestones outlineing the roadmap ahead</li>
<li>There will issues marked with help wanted</li>
</ul>
</li>
</ul>
<p>The issue list and the items marked with <strong>help wanted</strong> is a good starting point if you want to do some work.</p>
<h2 id="guidelines-for-avoiding-duplicate-work">Guidelines for avoiding duplicate work</h2>
<p>Contributing is great. It is not so fun when you are done with your issue and just before you're about to push your
change you cant because someone else just pushed the same fix so you have wasted your time. The guidelines below are in
place to prevent this:</p>
<ul>
<li>Comment in the issue that you are working on it. You will then be added as an assignee (eventually).</li>
<li>When you pick an issue to work on.<ul>
<li>Check that the issue not assigned</li>
<li>Also check the comments so that no one has started working on it before beeing officially assigned.</li>
</ul>
</li>
</ul>
<h2 id="submitting-changes">Submitting changes</h2>
<p>Please send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). When you send
a pull request, we will love you forever if you include jasmine tests. We can always use more test coverage.</p>
<p>Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:</p>
<p>$ git commit -m "A brief summary of the commit</p>
<blockquote>
<p>A paragraph describing what changed and its impact."
Coding conventions
Start reading our code and you'll get the hang of it. We optimize for readability:</p>
</blockquote>
<p>This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of
like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as
smooth as possible.</p>
<p>So that we can consistently serve images from the CDN, always use image_path or image_tag when referring to images.
Never prepend "/images/" when using image_path or image_tag.
Also for the CDN, always use cwd-relative paths rather than root-relative paths in image URLs in any CSS. So instead of
url('/images/blah.gif'), use url('../images/blah.gif').</p>
<h3 id="build-instructions">Build instructions</h3>
<p>Fork, then:</p>
<pre>npm install</pre><p>Then the dependencies will have been installed. You use gulp as build tool.</p>
<p>The following targets are probably interesting:</p>
<ul>
<li>jison - compiles the jison grammars to parser files</li>
<li>jasmine - runs the jasmine tests (will trigger the jison target)</li>
<li>dist - complies files to the dist catalog</li>
</ul>
<p>for instance:</p>
<pre>gulp jasmine</pre><p>Thanks, Knut Sveidqvist</p>
</article>
</div>
<section class="xlarge-30 large-30 medium-40 small-100 tiny-100">
<nav id="sidenav" class="ink-navigation ink-sticky bottom-space"
data-bottom-element="#sticky-stop">
<ul class="menu vertical black" id="sections">
<li class="heading active"><a href="#">Quicklinks:</a></li>
</ul>
</nav>
</section>
</section>
<div id="sticky-stop"> </div>
<section class="column-group gutters">
<div class="all-20 small-100 tiny-100">
<h3>heading</h3>
<img class="half-bottom-space" src="holder.js/1200x600/auto/ink" alt="">
<p>"Red is not the right word," was the reply. "The plague was scarlet. The whole face and body turned scarlet in an hour's time. Don't I know? Didn't I see enough of it? And I am telling you it was scarlet because—well, because it was scarlet. There is no other word for it."</p>
</div>
<div class="all-20 small-100 tiny-100">
<h3>heading</h3>
<img class="half-bottom-space" src="holder.js/1200x600/auto/ink" alt="">
<p>"Red is not the right word," was the reply. "The plague was scarlet. The whole face and body turned scarlet in an hour's time. Don't I know? Didn't I see enough of it? And I am telling you it was scarlet because—well, because it was scarlet. There is no other word for it."</p>
</div>
<div class="all-20 small-100 tiny-100">
<h3>heading</h3>
<img class="half-bottom-space" src="holder.js/1200x600/auto/ink" alt="">
<p>"Red is not the right word," was the reply. "The plague was scarlet. The whole face and body turned scarlet in an hour's time. Don't I know? Didn't I see enough of it? And I am telling you it was scarlet because—well, because it was scarlet. There is no other word for it."</p>
</div>
<div class="all-20 small-100 tiny-100">
<h3>heading</h3>
<img class="half-bottom-space" src="holder.js/1200x600/auto/ink" alt="">
<p>"Red is not the right word," was the reply. "The plague was scarlet. The whole face and body turned scarlet in an hour's time. Don't I know? Didn't I see enough of it? And I am telling you it was scarlet because—well, because it was scarlet. There is no other word for it."</p>
</div>
<div class="all-20 small-100 tiny-100">
<h3>heading</h3>
<img class="half-bottom-space" src="holder.js/1200x600/auto/ink" alt="">
<p>"Red is not the right word," was the reply. "The plague was scarlet. The whole face and body turned scarlet in an hour's time. Don't I know? Didn't I see enough of it? And I am telling you it was scarlet because—well, because it was scarlet. There is no other word for it."</p>
</div>
</section>
</div>
<footer class="clearfix">
<div class="ink-grid">
<ul class="unstyled inline half-vertical-space">
<li class="active"><a href="#">About</a></li>
<li><a href="#">Sitemap</a></li>
<li><a href="#">Contacts</a></li>
</ul>
<p class="note">Identification of the owner of the copyright, either by name, abbreviation, or other designation by which it is generally known.</p>
</div>
</footer>
</body>
</html>