mermaid
Version:
Markdownish syntax for generating flowcharts, sequence diagrams and gantt charts.
119 lines (114 loc) • 5.28 kB
HTML
<html>
<head>
<title>CONTRIBUTING.md</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="stylesheet" media="all" href="doc-style.css" />
<script src="doc-filelist.js"></script>
<script>
var relativeDir = "", thisFile = "Users/knut/Documents/source/mermaid/CONTRIBUTING.md", defaultSidebar = true;
</script>
<script src="doc-script.js"></script>
<script src="mermaid.js"></script>
<link rel="stylesheet" href="mermaid.css" />
</head>
<body>
<div id="sidebar_wrapper">
<div id="sidebar_switch">
<span class="tree">Files</span>
<span class="headings">Headings</span>
</div>
<div id="tree"></div>
<div id="headings">
<div class="heading h1">
<a href="#How to contribute">How to contribute</a>
</div>
<div class="heading h2">
<a href="#Guidelines for avoiding duplicate work">Guidelines for avoiding duplicate work</a>
</div>
<div class="heading h2">
<a href="#Submitting changes">Submitting changes</a>
</div>
<div class="heading h1">
<a href="#Build instructions">Build instructions</a>
</div>
</div>
</div>
<div id="sidebar-toggle"></div>
<div id="container"><div class="docs markdown"><div class="pilwrap" id="How to contribute">
<h1>
<a href="#How to contribute" name="How to contribute" class="pilcrow">¶</a>
How to contribute</h1>
</div>
<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 and 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>
<div class="pilwrap" id="Guidelines for avoiding duplicate work">
<h2>
<a href="#Guidelines for avoiding duplicate work" name="Guidelines for avoiding duplicate work" class="pilcrow">¶</a>
Guidelines for avoiding duplicate work</h2>
</div>
<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 can't 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>
<div class="pilwrap" id="Submitting changes">
<h2>
<a href="#Submitting changes" name="Submitting changes" class="pilcrow">¶</a>
Submitting changes</h2>
</div>
<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>
<div class="pilwrap" id="Build instructions">
<h1>
<a href="#Build instructions" name="Build instructions" class="pilcrow">¶</a>
Build instructions</h1>
</div>
<p>Fork, then:</p>
<div class="highlight"><pre><code><span class="nx">npm</span> <span class="nx">install</span>
</code></pre></div>
<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>
<div class="highlight"><pre><code><span class="nx">gulp</span> <span class="nx">jasmine</span>
</code></pre></div>
<p>Thanks, Knut Sveidqvist</p>
</div>
</div>
</body>
</html>