[mlpack-git] master: Add a page detailing how someone can get involved. (e460118)

Fri Mar 27 20:40:13 EDT 2015

Repository : https://github.com/mlpack/mlpack.org

On branch  : master
Link       : https://github.com/mlpack/mlpack.org/compare/ec30aa2e3fcd69e3fe8fd9b006bdcb033b3c8e8d...f38ec5f8431eea845df9cc0540dc8340fdfcf582

>---------------------------------------------------------------

commit e46011832f52c75a4955c5e75596dcd8566d8bf9
Author: Ryan Curtin <ryan at ratml.org>
Date:   Sat Mar 28 00:38:18 2015 +0000

    Add a page detailing how someone can get involved.


>---------------------------------------------------------------

e46011832f52c75a4955c5e75596dcd8566d8bf9
 involved.html | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 89 insertions(+)

diff --git a/involved.html b/involved.html
new file mode 100644
index 0000000..8628c47
--- /dev/null
+++ b/involved.html
@@ -0,0 +1,89 @@
+<html>
+<head>
+<!-- probably could use more keywords -->
+<meta name="keywords" content="mlpack, libmlpack, c++, armadillo, machine learning, data mining, classification, regression, tree-based methods, dual-tree algorithm">
+<meta name="description" content="mlpack: a scalable c++ machine learning library">
+<meta http-equiv="content-type" content="text/html; charset=UTF-8">
+<title>mlpack: a scalable c++ machine learning library</title>
+</head>
+<link rel="stylesheet" href="style.css">
+<link href='http://fonts.googleapis.com/css?family=Maven+Pro:500'
+rel='stylesheet' type='text/css'>
+<body>
+<!-- very simple table with as few words as possible -->
+<br>
+<div class="titlebar">
+   <a href="http://www.mlpack.org"><img src="mlpack.png"></a>
+</div>
+<center>
+<div class="mlnavbar">
+  <div class="navcontainer">
+   <div class="mlnavitem" name="mlnavmain"><a href="index.html">main</a></div>
+   <div class="mlnavitem" name="mlnavabout"><a href="about-main.html">about</a></div>
+   <div class="mlnavitem" name="mlnavdoc"><a href="doxygen.php">docs</a></div>
+   <div class="mlnavitem" name="mlnavhelp"><a href="help.html">get help</a></div>
+   <div class="mlnavitem" name="mlnavbugs"><a
+href="https://github.com/mlpack/mlpack">github</a></div>
+  </div>
+</div>
+</center>
+<div class="separator"></div>
+<center>
+<div class="mainsection smallertext">
+<center><h2><font class="whitebold">contributing to
+mlpack</font></h2></center>
+<p><font class="whitebold">mlpack</font> is an open-source project, so anyone is
+welcome to become a part of the community and contribute.  There is no need to
+be a machine learning expert to participate&mdash;often, there are many tasks to
+be done that don't require in-depth knowledge.</p>
+<p>A good place to start is to <a href="download.html">download</a> <font
+class="whitebold">mlpack</font>, compile it from source (<a
+href="doxygen.php?doc=build.html">tutorial</a>), and set up a development
+environment.  Once you've done this, it would probably be useful to get a feel
+for some of the algorithms <font class="whitebold">mlpack</font> implements by
+using some of the command-line programs (<a href="man.html">man pages</a>) to
+perform some machine learning tasks.</p>
+<p>Next, you can implement some <a href="doxygen.php?doc=sample.html">simple
+mlpack programs</a> and read through the <a href="tutorials.html">other
+tutorials</a>, and by the time you've finished with that you should have a
+pretty good handle on the way the library works.</p>
+<p>At this point, you're probably ready to jump in and start contributing.
+Development is done <a href="https://github.com/mlpack/mlpack">on Github</a>, so
+you'll need an account there, and you can submit patches or contributions via <a
+href="https://help.github.com/articles/using-pull-requests/">pull
+requests</a>.  Below are some useful links and tips:</p>
+<ul class="mainpage">
+<li><font class="gray">You can find a bug to solve on the <a
+href="https://github.com/mlpack/mlpack/issues">issues list</a>.  Issues
+(generally) have a <i>difficulty</i> label, which may help in selecting an issue
+that is interesting to you.</font></li><br>
+<li><font class="gray">Read the <a
+href="https://github.com/mlpack/mlpack/wiki/StyleGuidelines">style
+guidelines</a> to learn what your code should look like when you submit
+it.</font></li><br>
+<li><font class="gray">The <a
+href="https://github.com/mlpack/mlpack/wiki/ProposedNewDesignGuidelines">new
+design guidelines</a> can give insight into how to structure your
+contribution.</font></li><br>
+<li><font class="gray">Subscribe to the <a
+href="http://lists.cc.gatech.edu/mailman/listinfo/mlpack">mlpack</a> discussion
+mailing list to receive (or send) emails about <font
+class="whitebold">mlpack</font>.</font></li><br>
+<li><font class="gray">You may find it useful to subscribe to the <a
+href="http://lists.cc.gatech.edu/mailman/listinfo/mlpack-git">mlpack-git</a>
+mailing list to receive updates on git commits and Github issues (warning: can
+be high-traffic).</font></li><br>
+<li><font class="gray">The #mlpack IRC channel on freenode (<a
+href="http://webchat.freenode.net/?channels=mlpack">webchat</a>, <a
+href="irc/">channel logs</a>) is a good place to ask for help or discuss <font
+class="whitebold">mlpack</font> with other members of the community.</li><br>
+<li><font class="gray">Are you interested in a more long-term project?  See the <a
+href="https://github.com/mlpack/mlpack/wiki/SummerOfCodeIdeas">list of ideas</a>
+we maintain for Google Summer of Code</a>, and maybe that can provide a good
+starting point.</font></li>
+</ul>
+<p>Still not sure, or have some questions?  Get in touch via IRC, the
+mailing list, or <a href="help.html">any other way</a>.</p>
+</div>
+</body>
+</html>

