contrib_help.html

---
layout: default
---
<h1>Getting started with DlangScience</h1>
<p>Here is a pre-alpha draft of a bit of "getting started" documentation...</p>
<h2>Tips for newcomers</h2>
<ul>
<li>if you are new to the D programming language see <a href="http://dlang.org/getstarted.html">http://dlang.org/getstarted.html</a></li>
<li>DlangScience depends heavily on <a href="http://code.dlang.org/getting_started">dub</a> to manage package dependencies and versioning</li>
<li>for a quickstart tutorial, see <a href="http://d.readthedocs.org/en/latest/index.html">Getting Started in D</a></li>
<li>for a simple example using <code>dub</code> and a DlangScience module, see <a href="https://github.com/DlangScience/cblas/tree/master/examples/gemmTest">here</a>
<ul>
<li>for your own examples, change <code>"cblas": { "path": "../../" }</code> to something like <code>"cblas": "~&gt;0.1.0"</code></li>
<li>if you are using a new dub.sdl config file, add a line like: <code>dependency "cblas" version="~&gt;0.1.0"</code></li>
</ul>
</li>
</ul>
<h2>Contributing to DlangScience</h2>
<p>All the packages which make up DlangScience are hosted in their own github projects at <code>https://github.com/DlangScience/&lt;packageName&gt;</code>. For the time being, development is proceeding quite independently in the projects. For example, issues are tracked separately within their respective Github sites and each project can be forked and cloned separately.</p>
<h3>Guidelines for package owners</h3>
<ul>
<li>instructions needed ...</li>
<li>DUB usage instructions/pointers needed(?)</li>
</ul>
<h3>Guidelines for other contributors</h3>
<p>The basic process is:</p>
<ol>
<li>get a github account and install git on your computer</li>
<li>fork the project in github</li>
<li>clone your github fork to your own computer</li>
<li>create a feature branch and make/commit changes within the branch</li>
<li>push the branch to your github fork</li>
<li>create a pull request within Github</li>
</ol>
<p>The documentation for contributing to Numpy <a href="http://docs.scipy.org/doc/numpy-dev/dev/index.html">here</a> provides excellent material for getting started with Git. The section on [Development workflow] (<a href="http://docs.scipy.org/doc/numpy-dev/dev/gitwash/development_workflow.html">http://docs.scipy.org/doc/numpy-dev/dev/gitwash/development_workflow.html</a>) is relevent for any package of DlangScience (following instructions for contributors, not core developers).</p>
<p>The <a href="http://wiki.dlang.org/Pull_Requests#Rebasing">Rebasing</a> section of the Dlang wiki page on "pull requests" provides somewhat more succinct instructions that are also relevant here. (Note, however, the use "git pull" which is discouraged for newcomers in the NumPy instructions.)</p>