├── README.md └── ISSUES_GUIDE.md /README.md: -------------------------------------------------------------------------------- 1 | # community-help 2 | 3 | ## Motivation 4 | We have all been beginners once. At often times we spent hours searching for solutions to our various technicall problems, bugs or architecture questions. The more one codes, the more one understands such pains. 5 | 6 | Sharing knowledge is one of the core values of our community. We consider that providing help is an opportunity to share knowledge and to learn together. Therefore we decided to move help requests on GitHub in order to easily track their status. 7 | 8 | We find that helping others is fun! So go on, challenge us! The Cluj JavaScripters community will help you (and will enjoy doing it... ;) ). To get started you just need to [create an issue](https://github.com/cluj-javascripters/community-help/issues/new). 9 | 10 | But please make sure you read the [guide](https://github.com/cluj-javascripters/community-help/blob/master/ISSUES_GUIDE.md) before that. It clearly explains how to ask for help so that we can understand your problem and come up with a solution as fast as possible. 11 | -------------------------------------------------------------------------------- /ISSUES_GUIDE.md: -------------------------------------------------------------------------------- 1 | # Issues Guide 2 | 3 | We love helping others and we love a good challenge that will help us grow as well. 4 | That's why we created this repo. To be the "go-to and ask for help" side of our community. 5 | 6 | However, it's important to you and us as well to try to minimize the time spent on analyzing issues. 7 | This guide lays down a couple of points that we would like you to read before proceeding with asking for help. 8 | 9 | ### Rules for opening a new issue 10 | 11 | __1. Be specific__ 12 | 13 | As much as we would like to help you with anything, we will not be able to. We too have limited time at our 14 | disposal, so being specific in your request helps a lot. Unfortunately, we will not consider issues such as: __"I need help with my project!"__ or 15 | __"Please help me asap!"__. We hope you understand we cannot analyze a big context so please take your 16 | time and try to isolate on your own the problem that you have. 17 | 18 | __2. Help us by providing code samples__ 19 | 20 | It's very important to to us to form a mental picture as soon as possible. So please provide us 21 | with some code examples, explaining what you are trying to do, how the codebase currently looks, 22 | what errors do you get, etc. For this you can use [jsbin](https://jsbin.com/?html,output) or [plunker](https://plnkr.co/) 23 | or whatever you want. We acknowledge this is an extra effort from your side, but it's well worth 24 | it if you want to maximize our chances of helping you. 25 | 26 | __3. Focus on written communication__ 27 | 28 | As much as we'd love to help you by jumping in a Skype/Hangouts/w/e call with you, the truth 29 | is, we won't be able to. So try to focus on written communication (detail your problem, provide 30 | context, let us know how we can get back to you, etc.) 31 | 32 | __4. If you solved it, let us know__ 33 | 34 | There's nothing better than you figuring out solutions on your own. If this happens, then congratulations! 35 | You've just increased your skills and became a better professional! In this situation, we kindly ask 36 | you to take some time and post your solution on the issue you opened and then close it, so that we can 37 | focus only on those that are still alive and haven't been solved yet. Remember that, by doing this, 38 | you will help us as well as the community (someone else may have similar problems and find your 39 | answer helpful). 40 | 41 | __5. We don't know everything__ 42 | 43 | The JS landscape is incredibly vast. Although we try our best to keep up to date with everything, the 44 | truth is there are a lot of things we don't know either (from JS frameworks to plugins in the ecosystem). So sometimes, we will not be able to help you right away. 45 | In those cases, we would appreciate that you understand this and try to make the process a collaborative one 46 | (we learn together and dissect the problem). Focusing on a productive communication will be the 47 | key to getting to a solution as fast as possible. 48 | 49 | __6. We answer when we can__ 50 | 51 | Our focus is on helping you. And we try our best at this. But we do have other responsibilities 52 | during the day (coding, meetings at work, long calls with clients, etc.). We always try to get back 53 | to you as soon as possible, but we ask that you understand there is no timeframe for this and that, sometimes, 54 | other things will take priority. Please be patient, don't spam the issue thread, don't get 55 | angry/violent in communication and most importantly, don't give up on finding the answer on your own. 56 | There's nothing more valuable than you putting effort into undersanding and solving the problem by yourself. 57 | And if this happens, remember __point 4__ :P. 58 | 59 | --------------------------------------------------------------------------------