/usr/share/doc/simgrid/html/contributing.html is in simgrid-doc 3.10-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SimGrid: Contributing to SimGrid</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SimGrid
 <span id="projectnumber">3.10</span>
</div>
<div id="projectbrief">Versatile Simulation of Distributed Systems</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="http://simgrid.gforge.inria.fr/"><span>Home page</span></a></li>
<li><a href="http://simgrid.gforge.inria.fr/documentation.html"><span>Online documentation</span></a></li>
<li><a href="https://gforge.inria.fr/projects/simgrid"><span>Dev's Corner</span></a></li>
<li> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('contributing.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Contributing to SimGrid </div> </div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><li class="level1"><a href="#contributing_spread">Spread the word</a></li>
<li class="level1"><a href="#contributing_bugs">Reporting (and fixing) any issue you find</a></li>
<li class="level1"><a href="#contributing_contrib">Contributing features and associated tools</a></li>
</ul>
</div>
<div class="textblock"><p>We are sometimes asked by users how to give back to the project. Here are some ideas, but if you have new ones, feel free.</p>
<h1><a class="anchor" id="contributing_spread"></a>
Spread the word</h1>
<p>There is many ways to help the SimGrid project. The first and most natural one is to <b>use it for your research, and say so</b>. Cite the SimGrid framework in your paper and discuss of its advantages with your colleagues to spread the word. When we ask for new fundings to sustain the project, the amount of publications enabled by SimGrid is always the first question that we get. The more you use the framework, the better for us.</p>
<p>We use several systems to detect the scientific publications citing our work, so actually citing correctly the framework (see <a href="http://simgrid.gforge.inria.fr/Publications.html">here</a>) should be enough to get us adding your paper to our list. But if you remark that your paper is missing on <a href="http://simgrid.gforge.inria.fr/Publications-tool.html">our page listing all papers using SimGrid</a>, please say so. Likewise, if your paper is badly cited, please drop us an email so that we can fix it.</p>
<p>Also, <b>help us constituting an active and welcoming user community</b>. Get subscribed to the mailing lists, and answer the questions that newcommers have if you can. Point them (gentely ;) to the relevant part of the documentation on need, and help them becoming part of our community too.</p>
<p>Another easy way to help the project is to add a link to the <a href="http://simgrid.gforge.inria.fr">SimGrid homepage</a> on your homepage to <b>improve SimGrid's ranking in the search engines</b>. Internet visibility is a battle where you can make the difference. This can be done by adding the following html snipet to your page, that simply renders as <a href="http://simgrid.gforge.inria.fr/">Simgrid</a>.</p>
<pre class="fragment"><a href="http://simgrid.gforge.inria.fr/"
title="Versatile simulation of distributed systems: Grid Simulator, P2P simulator, MPI simulator, Cloud Simulator or HPC Simulator">
Simgrid</a>
</pre><p>Or you can prefer this version with a little logo (if you want to contribute another logo for that, please don't hesitate ;) </p>
<div class="image">
<img src="http://simgrid.gforge.inria.fr/logos/SIMGRID_Logo_Thumbs_up.png" />
</div>
<pre class="fragment"><a href="http://simgrid.gforge.inria.fr/"
title="Versatile simulation of distributed systems: Grid Simulator, P2P simulator, MPI simulator, Cloud Simulator or HPC Simulator">
<img src="http://simgrid.gforge.inria.fr/logos/SIMGRID_Logo_Thumbs_up.png"
alt="Versatile simulation of distributed systems: Grid Simulator, P2P simulator, MPI simulator, Cloud Simulator or HPC Simulator" align="center">
</a>
</pre><p>Finally, if you organize a scientific event where you expect many potential users, <b>invite us to give a tutorial on SimGrid</b>. We found that 45 minutes to one hour is sufficient. It allows to explain the main motivations and outcomes of the project in order to motivate the attendees get more information on SimGrid, and eventually improve their scientific habits by using a sound simulation framework. <a href="http://webloria.loria.fr/~quinson/blog/2012/1120/Simgrid_at_Louvain/">Here</a> is an example of such a presentation.</p>
<h1><a class="anchor" id="contributing_bugs"></a>
Reporting (and fixing) any issue you find</h1>
<p>Because of its size and complexity, SimGrid is not perfect and contains a large amount of glitches and issues. When you find one, don't assume that it's here because we don't care. It survived only because nobody told us. We unfortunately cannot endlessly review our large code and documentation base. So please, <b>report any issue you find to us</b>, be it a typo in the documentation, a paragraph that needs to be reworded, a bug in the code or any other problem. The best way to do so is to open a bug on our <a href="https://gforge.inria.fr/tracker/?atid=165&group_id=12&func=browse">Bug Tracking System</a> so that we don't forget about it (we have other obligations too and are sometimes unable to fix bugs right away, no matter how easy the fix it). The worst way to report such issue is to go through private emails. These are unreliable, and we are trying to develop SimGrid openly, so private discussions are to be avoided if possible.</p>
<p>If you can provide a patch fixing the issue you report, that's even better, and often ensures that it will get fixed very soon.</p>
<p>Of course, a very good way to give back to the SimGrid community is to <b>triage and fix the bugs in the BTS</b>. If you can come up with a patch fixing them, we will be more than happy to apply your changes so that the entier community enjoys them.</p>
<h1><a class="anchor" id="contributing_contrib"></a>
Contributing features and associated tools</h1>
<p>If you deeply miss a feature in the framework, you should consider implementing it yourself. That's free software, meaning that you are free to help yourself. Of course, we'll do our best to assist you in this task, so don't hesitate to contact us with your idea.</p>
<p>If you develop an independent tool that is somehow associated to SimGrid, we'd love helping you gaining visibility by listing it on our <a href="http://simgrid.gforge.inria.fr/contrib.html">Contrib section</a>. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Sun Nov 17 2013 21:34:47 for SimGrid by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
</ul>
</div>
</body>
</html>
|