75 lines
8.6 KiB
HTML
75 lines
8.6 KiB
HTML
<!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"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: docs/CONTRIBUTING.md Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.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 id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">EnTT
|
|
 <span id="projectnumber">2.7.3</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</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">docs/CONTRIBUTING.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> # Contributing</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> First of all, thank you very much for taking the time to contribute to the</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> `EnTT` framework.<br/></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> How to do it mostly depends on the type of contribution:</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> * If you have a question, **please** ensure there isn't already an answer for</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  you by searching on GitHub under</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  [issues](https://github.com/skypjack/entt/issues). Do not forget to search</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  also through the closed ones. If you are unable to find a proper answer, feel</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  free to [open a new issue](https://github.com/skypjack/entt/issues/new).</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  Usually, questions are marked as such and closed in a few days.</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> * If you want to fix a typo in the inline documentation or in the README file,</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  if you want to add some new sections or if you want to help me with the</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  language by reviewing what I wrote so far (I'm not a native speaker after</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  all), **please** open a new</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  [pull request](https://github.com/skypjack/entt/pulls) with your changes.</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> * If you found a bug, **please** ensure there isn't already an answer for you by</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  searching on GitHub under [issues](https://github.com/skypjack/entt/issues).</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  If you are unable to find an open issue addressing the problem, feel free to</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  [open a new one](https://github.com/skypjack/entt/issues/new). **Please**, do</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  not forget to carefully describe how to reproduce the problem, then add all</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  the informaion about the system on which you are experiencing it and point out</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  the version of `EnTT` you are using (tag or commit).</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> * If you found a bug and you wrote a patch to fix it, open a new</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  [pull request](https://github.com/skypjack/entt/pulls) with your code.</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  **Please**, add some tests to avoid regressions in future if possible, it</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  would be really appreciated. Note that the `EnTT` framework has a</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  [coverage at 100%](https://coveralls.io/github/skypjack/entt?branch=master)</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  (at least it was at 100% at the time I wrote this file) and this is the reason</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  for which you can be confident with using it in a production environment.</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> * If you want to propose a new feature and you know how to code it, **please**</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  do not issue directly a pull request. Before to do it,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  [create a new issue](https://github.com/skypjack/entt/issues/new) to discuss</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  your proposal. Other users could be interested in your idea and the discussion</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  that will follow can refine it and therefore give us a better solution.</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> * If you want to request a new feature, I'm available for hiring. Take a look at</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  [my profile](https://github.com/skypjack) and feel free to write me.</div></div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|