diff options
author | Antenore Gatta <antenore@simbiosi.org> | 2019-07-31 16:33:11 +0300 |
---|---|---|
committer | Antenore Gatta <antenore@simbiosi.org> | 2019-07-31 16:33:11 +0300 |
commit | f311a32a40e5aa8a845bab5d5163f867db7299b8 (patch) | |
tree | f84e85dd806ac8d8b748b6273301798feacf961b /public/_c_o_n_t_r_i_b_u_t_i_n_g_8md_source.html | |
parent | cd33649dba716e348b93255874b4a9b982407db6 (diff) |
Automatic doc build by remmina-ci
Diffstat (limited to 'public/_c_o_n_t_r_i_b_u_t_i_n_g_8md_source.html')
-rw-r--r-- | public/_c_o_n_t_r_i_b_u_t_i_n_g_8md_source.html | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/public/_c_o_n_t_r_i_b_u_t_i_n_g_8md_source.html b/public/_c_o_n_t_r_i_b_u_t_i_n_g_8md_source.html index de462d189..ba1f56b0b 100644 --- a/public/_c_o_n_t_r_i_b_u_t_i_n_g_8md_source.html +++ b/public/_c_o_n_t_r_i_b_u_t_i_n_g_8md_source.html @@ -86,7 +86,7 @@ $(document).ready(function(){initNavTree('_c_o_n_t_r_i_b_u_t_i_n_g_8md.html','') <div class="title">CONTRIBUTING.md</div> </div> </div><!--header--> <div class="contents"> -<a href="_c_o_n_t_r_i_b_u_t_i_n_g_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> # Contributing to Remmina</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> Given the implied openness of the project, contributing to Remmina is extremely simple.</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> Everything is needed to contribute is well known and available to be used, and, most important, we are a kind, openminded, simple community.</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> In this page you should find everything you need to know if you want to contribute, if it misses anything let us know or try to fix it yourself.</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> ## Writing Code</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> **Remmina** uses the popular [Fork and Pull](http://stackoverflow.com/questions/11582995/what-is-the-fork-pull-model-in-github) model when it comes to contributing.</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> If you&#8217;d like to make changes to this project then the following basic steps will get you there!</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>  1. Fork [this repo](https://gitlab.com/Remmina/Remmina/forks/new)</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  2. Make your changes</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  3. [Submit a merge request](https://gitlab.com/Remmina/Remmina/merge_requests/new)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> See our [wiki](https://gitlab.com/Remmina/Remmina/wikis/home) to know how to compile Remmina and FreeRDP.</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> In general look at the issues labeled [&#8220;help wanted&#8221;](https://gitlab.com/Remmina/Remmina/issues?label_name%5B%5D=help+wanted), it&#8217;s probably the best place where to start. If you would like to earn some money there are some bounties available, see below for more details.</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> ### Fix existing bugs</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> This, in general, should be the most important task.</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> At the moment there are not critical bugs to be fixed, but several annoyances and enhancements that we&#8217;d like to fix.</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> To see all the issues already labeled as bug, you can use [this query](https://gitlab.com/Remmina/Remmina/issues?label_name%5B%5D=bug)</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> Some examples are:</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  * [#146](https://gitlab.com/Remmina/Remmina/issues/146) : XFCE intercepts shortcuts no matter of &#8220;Grab all keyboard events&#8221; button</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  * [#190](https://gitlab.com/Remmina/Remmina/issues/190) : Modifier keys (alt) are wrongly mapped across a Ubuntu -> Mac remote session</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  * [#380](https://gitlab.com/Remmina/Remmina/issues/380) : Segfault on apparently invalid pixel data bug unconfirmed</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  * [#246](https://gitlab.com/Remmina/Remmina/issues/246) : Clipboard Sync from Mac OS X to Linux over VNC Not Working</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> ### Implement most wanted features and fixes (_bounty $305_)</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> Similarly, we have a quite important list of feature requests, that are labeled as [enhancement](https://gitlab.com/Remmina/Remmina/issues?label_name%5B%5D=enhancement&sort=created_date&state=opened), of which some that have a [bounty](https://gitlab.com/Remmina/Remmina/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=enhancement&label_name[]=bounty) for those that will be able to implement them.</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  * ~~ [#6](https://gitlab.com/Remmina/Remmina/issues/6) : New resolution setting &#8220;fit to window&#8221; [$250] ~~ Implemented by @giox069</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  * [#323](https://gitlab.com/Remmina/Remmina/issues/323) : File transfer in RDP plugin [$25]</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  * [#476](https://gitlab.com/Remmina/Remmina/issues/476) : Favorite and recent connections [$5]</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  * [#815](https://gitlab.com/Remmina/Remmina/issues/815) : Feature request &#8211; Option &#8211; Floating Desktop Name [$5]</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  * [#376](https://gitlab.com/Remmina/Remmina/issues/376) : RDP: Multi monitor support [$15]</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> ### Internal projects</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  * Refactoring [remmina\_connection\_window.c](https://gitlab.com/Remmina/Remmina/blob/next/remmina/src/remmina_connection_window.c) as it is big, complicated and hard to extend.</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  * Simplify the user interface.</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  * Separate plugin processes from the main process to improve stability.</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  * Write an additional plugin system to write plugins also in Python and eventually Ruby.</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> ## Report bugs, ideas, issues</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> Install it, use it and report back to us. Whatever you find that it doesn&#8217;t work, it&#8217;s missing, it&#8217;s ugly don&#8217;t hesitate to let us know.</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> For bug and feature requests use [GitLab issues](https://gitlab.com/Remmina/Remmina/issues) For discussions you can use G+, reddit ad irc (we are not often connected, be patient)</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> ## Translating</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> You can help translate Remmina, some basic instructions to get started are documented in the [How-to-translate-Remmina Wiki](https://gitlab.com/Remmina/Remmina/wikis/How-to-translate-Remmina)</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> ## Documenting</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> We need much more user and developer guides. You can submit any (accessible) format you want for the user guides (screencasts, pdf, html, Open Document, gs, ps, LaTeX, gitlab wiki , etc).</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> For the developers the same and we need to document much more the source code.</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> ### Screenshots</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> Send us your nice embodied desktops.</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> ## Donating</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> If you rather prefer to contribute to Remmina with money you are more than welcome.</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> For more informations See the [Remmina web site donation page](https://remmina.org/donations/).</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> See the [THANKS.md](THANKS.md) file for an exhaustive list of supporters.</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div></div><!-- fragment --></div><!-- contents --> +<a href="_c_o_n_t_r_i_b_u_t_i_n_g_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> # Contributing to Remmina</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> Given the implied openness of the project, contributing to Remmina is extremely simple.</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> Everything is needed to contribute is well known and available to be used, and, most important, we are a kind, openminded, simple community.</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> In this page you should find everything you need to know if you want to contribute, if it misses anything let us know or try to fix it yourself.</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> ## Writing Code</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> **Remmina** uses the popular [Fork and Pull](http://stackoverflow.com/questions/11582995/what-is-the-fork-pull-model-in-github) model when it comes to contributing.</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> If you&#8217;d like to make changes to this project then the following basic steps will get you there!</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>  1. Fork [this repo](https://gitlab.com/Remmina/Remmina/forks/new)</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  2. Make your changes</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  3. [Submit a merge request](https://gitlab.com/Remmina/Remmina/merge_requests/new)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> See our [wiki](https://gitlab.com/Remmina/Remmina/wikis/home) to know how to compile Remmina and FreeRDP.</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> In general look at the issues labeled [&#8220;help wanted&#8221;](https://gitlab.com/Remmina/Remmina/issues?label_name%5B%5D=help+wanted), it&#8217;s probably the best place where to start. If you would like to earn some money there are some bounties available, see below for more details.</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> ### Fix existing bugs</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> This, in general, should be the most important task.</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> At the moment there are not critical bugs to be fixed, but several annoyances and enhancements that we&#8217;d like to fix.</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> To see all the issues already labeled as bug, you can use [this query](https://gitlab.com/Remmina/Remmina/issues?label_name%5B%5D=bug)</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> Some examples are:</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  * [#146](https://gitlab.com/Remmina/Remmina/issues/146) : XFCE intercepts shortcuts no matter of &#8220;Grab all keyboard events&#8221; button</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  * [#190](https://gitlab.com/Remmina/Remmina/issues/190) : Modifier keys (alt) are wrongly mapped across a Ubuntu -> Mac remote session</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  * [#380](https://gitlab.com/Remmina/Remmina/issues/380) : Segfault on apparently invalid pixel data bug unconfirmed</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  * [#246](https://gitlab.com/Remmina/Remmina/issues/246) : Clipboard Sync from Mac OS X to Linux over VNC Not Working</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> ### Implement most wanted features and fixes (_bounty $305_)</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> Similarly, we have a quite important list of feature requests, that are labeled as [enhancement](https://gitlab.com/Remmina/Remmina/issues?label_name%5B%5D=enhancement&sort=created_date&state=opened), of which some that have a [bounty](https://gitlab.com/Remmina/Remmina/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=enhancement&label_name[]=bounty) for those that will be able to implement them.</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  * ~~ [#6](https://gitlab.com/Remmina/Remmina/issues/6) : New resolution setting &#8220;fit to window&#8221; [$250] ~~ Implemented by @giox069</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  * [#323](https://gitlab.com/Remmina/Remmina/issues/323) : File transfer in RDP plugin [$25]</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  * [#476](https://gitlab.com/Remmina/Remmina/issues/476) : Favorite and recent connections [$5]</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  * [#815](https://gitlab.com/Remmina/Remmina/issues/815) : Feature request &#8211; Option &#8211; Floating Desktop Name [$5]</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  * [#376](https://gitlab.com/Remmina/Remmina/issues/376) : RDP: Multi monitor support [$15]</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> ### Internal projects</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  * Refactoring [remmina\_connection\_window.c](https://gitlab.com/Remmina/Remmina/blob/next/remmina/src/remmina_connection_window.c) as it is big, complicated and hard to extend.</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  * Simplify the user interface.</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  * Separate plugin processes from the main process to improve stability.</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  * Write an additional plugin system to write plugins also in Python and eventually Ruby.</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> ## Report bugs, ideas, issues</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> Install it, use it and report back to us. Whatever you find that it doesn&#8217;t work, it&#8217;s missing, it&#8217;s ugly don&#8217;t hesitate to let us know.</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> For bug and feature requests use [GitLab issues](https://gitlab.com/Remmina/Remmina/issues) For discussions you can use reddit ad irc (we are not often connected, be patient)</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> ## Translating</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> You can help translate Remmina, some basic instructions to get started are documented in the [How-to-translate-Remmina Wiki](https://gitlab.com/Remmina/Remmina/wikis/How-to-translate-Remmina)</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> ## Documenting</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> We need much more user and developer guides. You can submit any (accessible) format you want for the user guides (screencasts, pdf, html, Open Document, gs, ps, LaTeX, gitlab wiki , etc).</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> For the developers the same and we need to document much more the source code.</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> ### Screenshots</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> Send us your nice embodied desktops.</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> ## Donating</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> If you rather prefer to contribute to Remmina with money you are more than welcome.</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> For more informations See the [Remmina web site donation page](https://remmina.org/donations/).</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> See the [THANKS.md](THANKS.md) file for an exhaustive list of supporters.</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div></div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |