diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7a3ad68 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,94 @@ +# Contributing to Remmina + +Given the implied openness of the project, contributing to Remmina is extremely simple. +Everything is needed to contribute is well known and available to be used, and, most important, we are a kind, openminded, simple community. + +In this page you should find everything you need to know if you want to contribute, if it misses anything let us know otr try to fix it yourself. + +## Writing Code + +`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. + +If you'd like to make changes to this project then the following basic steps will get you there! + +1. Fork [this repo](https://github.com/FreeRDP/Remmina#fork-destination-box) +2. Make your changes +3. [Open a pull request](https://github.com/FreeRDP/Remmina/compare) + +See our [wiki](https://github.com/FreeRDP/Remmina/wiki) to know how to compile Remmina and FreeRDP. + +In general look at the issues labeled ["help wanted"](https://github.com/FreeRDP/Remmina/issues?utf8=✓&q=is%3Aopen%20sort%3Acreated-asc%20label%3A"help%20wanted"), it's probaly the best place where to start. +If you would like to earn some money there are some bounties available, see below for more details. + +### Fix existing bugs + +This, in general, should be the most important task. + +At the moment there are not critical bugs to be fixed, but several annoyances and enhancements that we'd like to fix. + +To see all the issues already labeled as bug, you can use [this query](https://github.com/FreeRDP/Remmina/issues?milestone=none&state=open&sort=created&labels=bug&direction=asc) + +Some exemples are: + +- #146 : XFCE intercepts shortcuts no matter of "Grab all keyboard events" button +- #190 : Modifier keys (alt) are wrongly mapped across a Ubuntu -> Mac remote session +- #380 : Segfault on apparently invalid pixel data bug unconfirmed +- #246 : Clipboard Sync from Mac OS X to Linux over VNC Not Working + +### Implement most wanted features and fixes (_bounty $240_) + +Similarly, we have a quite important list of feature requests, that are labeled as [enhancement](https://github.com/FreeRDP/Remmina/issues?milestone=none&state=open&sort=created&labels=enhancement&direction=asc), +of which some that have a [bounty](https://github.com/FreeRDP/Remmina/issues?milestone=none&state=open&sort=created&labels=enhancement%2Cbounty&direction=asc) for those that will be able to implement them. + +- #6: New resolution setting "fit to window" [$220] +- #323: File transfer in RDP plugin [$10] +- #476: Favorite and recent connections [$5] +- #815: Feature request - Option - Floating Desktop Name [$5] + +### Internal projects + +- Refactorying [remmina_connection_window.c](https://github.com/FreeRDP/Remmina/blob/next/remmina/src/remmina_connection_window.c) as it is big, complicated and hard to extend. +- Simplify the user interface. +- Move away from the thread model and go back to a fork model. +- Write an additional plugin system to write plugins also in Python and eventually Ruby. + +## Report bugs, ideas, issues + +Install it, use it and report back to us. +Whatever you find that it doesn't work, it's missing, it's ugly don't hesitate to let us know. + +For bug and feature requests use [GitHub issues](https://github.com/FreeRDP/Remmina/issues) +For discussions you can use G+, reddit ad irc (we are not often connected, be patient) + +## Documenting + +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, github wiki , etc). + +For the developers the same and we need to document much more the source code. + +### Screenshots + +Send us your nice embodied desktops. + +## Donating + +If you rather prefer to contribute to Remmina with money you are more than welcome. + +For more informations See the [Remmina web site donation page](http://remmina.org/wp/donations). + +See the [THANKS.md](https://raw.githubusercontent.com/FreeRDP/Remmina/next/THANKS.md) file for an exhaustive list of supporters. + +#### Paypal + +[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZBD87JG52PTZC) + +#### Bitcoin + +[](bitcoin:1298H2vaxcbDQRuRYkDjfFbvGEgxE1CNjk?label=Remmina%20Donation) + +If clicking on the line above does not work, use this payment info: + +- Remmina bitcoin address: 1298H2vaxcbDQRuRYkDjfFbvGEgxE1CNjk +- Message: Remmina Donation + |