|
| 1 | +# Contributing to Rubberduck |
| 2 | + |
| 3 | +Thank you very much for taking the time to contribute! |
| 4 | + |
| 5 | +The following is a set of guidelines and links to helpful resources to get you started. |
| 6 | + |
| 7 | +## Code of Conduct |
| 8 | + |
| 9 | +Rubberduck as of now has no formalized Code of Conduct. |
| 10 | +Yet the following guidelines apply in no particular order: |
| 11 | + |
| 12 | +- Apply common sense?! |
| 13 | +- Show and deserve respect |
| 14 | +- Be nice |
| 15 | +- We don't bite :) |
| 16 | +- Assume people's best intentions unless proven otherwise |
| 17 | + |
| 18 | +## How can I contribute? |
| 19 | + |
| 20 | +### Bug Reports |
| 21 | + |
| 22 | +The development team is always happy to hear about bugs. Reported bugs and other issues are opportunities to make Rubberduck even better. |
| 23 | + |
| 24 | +Before you report your bug, please check the [GitHub Issues](https://github.com/rubberduck-vba/Rubberduck/issues). |
| 25 | +The team spends quite some time to label the issues nicely so that you can find already known problems. |
| 26 | + |
| 27 | +To enable the fastest response possible, please include the following information in your Bug report wherever applicable: |
| 28 | + |
| 29 | +- The Version of Rubberduck you are running. |
| 30 | +- Steps to reproduce the issue (Code?). |
| 31 | +- A **full and complete** logfile, preferrably at TRACE-level |
| 32 | +- Screenshots? |
| 33 | +- ... |
| 34 | + |
| 35 | +When posting a CLR/JIT stack trace, please avoid cluttering the issue with the "loaded assemblies" part; that (very) long list of loaded DLL's isn't relevant. |
| 36 | + |
| 37 | +### Suggesting Enhancements |
| 38 | + |
| 39 | +The team is always happy to hear your ideas. Please do make sure you checked, whether someone else already requested something similar. |
| 40 | +The label [enhancement] will be a good guide. |
| 41 | + |
| 42 | +Do note that despite the rather large scope of Rubberduck, some things are just **too large** or **too complex** for Rubberduck to effectively support. |
| 43 | +Please don't be discouraged if your idea gets declined, your feedback is very valuable. |
| 44 | + |
| 45 | +As with Bug Reports the more exact you define what's your gripe, the quicker we can get back to you. |
| 46 | + |
| 47 | +### The Wiki |
| 48 | + |
| 49 | +The Rubberduck Wiki is open for editing to everybody that has a Github account. |
| 50 | +This is very much intentional. |
| 51 | +Everybody is welcome to improve and expand the wiki. |
| 52 | + |
| 53 | +### Coding and Related |
| 54 | + |
| 55 | +So you want to get your hands dirty and fix that obnoxious bug in the last release? |
| 56 | +Well **great**, we like seeing new faces in the fray :) |
| 57 | +Or you just want to find something that you can contribute to to learn C#? Or ... |
| 58 | +Well whatever your motivation is, we recommend taking a look at issues that are labeled [\[up-for-grabs\]](https://github.com/rubberduck-vba/Rubberduck/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs). |
| 59 | + |
| 60 | +Our Ducky has come quite the long way and is intimidatingly large for a first-time (or even long-time) contributor. |
| 61 | +To make it easier to find something you can do, all issues with that label are additionally labelled with a difficulty. |
| 62 | +That difficulty level is a best-guess by the dev-team how complex or evil an issue will be. |
| 63 | + |
| 64 | +If you're new to C#, we recommend you start with \[difficulty-01-duckling\]. The next step \[difficulty-02-ducky\] requires some knowledge about C#, but not so much about how Rubberduck works |
| 65 | + |
| 66 | +Then there's \[difficulty-03-duck\] which requires a good handle on C# and at least an idea of how the components of Rubberduck play toghether. |
| 67 | +And finally there's \[difficulty-04-quackhead\] for when you really want to bang your head against the wall. |
| 68 | +They require both good knowledge of C# and a deep understanding of how Rubberduck works. |
| 69 | + |
| 70 | +In addition to this, a few people have put together some helpful resources about how Rubberduck works internally and help contributors tell left from right in the ~250k Lines of Code. |
| 71 | + |
| 72 | +You can find their work in the [github wiki](https://github.com/rubberduck-vba/Rubberduck/wiki). If something in there doesn't quite seem to match, it's probably because nobody got around to updating it yet. You're very welcome to **improve** the wiki by adding and correcting information. (see right above) |
| 73 | + |
| 74 | +In case this doesn't quite help you or the information you need hasn't been added to the wiki, you can **always** ask questions. |
| 75 | +Please do so in the ["War room"](https://chat.stackexchange.com/rooms/14929). |
| 76 | +Note that you will need an account on any of the Stack Exchange sites with at least 20 reputation points to ask questions there. |
| 77 | +Other than that, you can also open an issue with the label \[support\], but it may take longer to get back to that. |
| 78 | + |
| 79 | +In that room the core team talks about the duck and whatever else comes up. |
| 80 | +N.B.: The rules of the Stack Exchange Network apply to everything you say in that room. But basically those are the same rules as those in the [CoC](#Code_of_Conduct). |
| 81 | + |
| 82 | +Whether you create an issue or a pull request, please avoid using `[` square brackets `]` in the title, and try to be as descriptive (but succinct) as possible. Square brackets in titles confuse our chat-bot, and end up rendering in weird broken ways in SE chat. Avoid riddles, bad puns and other would-be funny (or NSFW) titles that don't really describe the issue or PR. |
| 83 | + |
| 84 | +### Translations |
| 85 | + |
| 86 | +Rubberduck is Localized in multiple languages. |
| 87 | +All these translations have been provided by volunteers. |
| 88 | +We welcome both new translations as well as improvements to current translations very much. |
| 89 | + |
| 90 | +The resource files are RESX/XML files easily editable in any text editor, but comparing resource keys across languages/translations is much easier done with @Vogel612's [Translation Helper](https://github.com/Vogel612/TranslationHelper) tool, which automatically adds missing keys and highlights entries that need a new translation. |
| 91 | + |
| 92 | +If you contribute a translation for a brand new previously unsupported language, keep in touch with the dev team so that new resource keys can be translated when a new release is coming up; abandoned languages/translations will end up getting dropped. |
| 93 | + |
| 94 | +## What comes out of it for me? |
| 95 | + |
| 96 | +Well ... the eternal gratitude of all Rubberduck users for one :wink: |
| 97 | +Aside from that, all contributors are explicitly listed by name (or alias) in the "About Rubberduck" window. |
| 98 | +In addition to that, there is some [Contributor-only Rubberduck swag](https://gofundme.com/rubberduckvba), that can be sent to you, at the discretion of @retailcoder.. while supplies last. |
0 commit comments