TrustedUser
2,147
edits
Difference between revisions of "Summer of Code/Project Rules"
Jump to navigation
Jump to search
Summer of Code/Project Rules (view source)
Revision as of 10:23, 20 March 2018
, 10:23, 20 March 2018no edit summary
(Improve both formatting and content) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 8: | Line 8: | ||
* '''Get in touch with us''' and our community. In particular, visit our IRC channel #scummvm on irc.freenode.net, and/or email the technical contacts listed on the [[GSoC Ideas]] page for each task that sounds appealing to you. | * '''Get in touch with us''' and our community. In particular, visit our IRC channel #scummvm on irc.freenode.net, and/or email the technical contacts listed on the [[GSoC Ideas]] page for each task that sounds appealing to you. | ||
''Your best chance to find out whether ScummVM is right for you, and whether you are right for ScummVM, is to talk to us. We'll be happy to answer your questions, and help you decide whether you like to work with us. Your chances of being accepted later on will also be much higher if we already know you a bit. And finally, regular attendance of our IRC channel is almost mandatory if you want to work with us anyway ;-)'' | ''Your best chance to find out whether ScummVM is right for you, and whether you are right for ScummVM, is to talk to us. We'll be happy to answer your questions, and help you decide whether you like to work with us. Your chances of being accepted later on will also be much higher if we already know you a bit. And finally, regular attendance of our IRC channel is almost mandatory if you want to work with us anyway ;-)'' | ||
* '''Get familiar with the code base'''. Clone our GitHub repository, compile the source code. Play with it. See [[Developer_Central]] for how to get started. | |||
''You will need to know a bit about the project to work on your application. Also as part of the application you will need to provide a pull request with some code change to demonstrate that you can work with the code base (see [[#Before you are accepted...|Before you are accepted...]] below).'' | |||
==Before you are accepted...== | ==Before you are accepted...== | ||
* Prepare a '''comprehensive and detailed plan for all 12 weeks of your project'''. Include risk mitigation (you might fall ill, a phase in your project be more complicated than anticipated, etc.) and any existing commitments such as exams, vacations etc. | * Prepare a '''comprehensive and detailed plan for all 12 weeks of your project'''. Include risk mitigation (you might fall ill, a phase in your project be more complicated than anticipated, etc.) and any existing commitments such as exams, vacations etc. | ||
''This plan will help you and us to decide at any time during the project how well you are progressing. It forces you to think about what you need to do beforehand, and provides a guideline for you while GSoC is progressing.'' | ''This plan will help you and us to decide at any time during the project how well you are progressing. It forces you to think about what you need to do beforehand, and provides a guideline for you while GSoC is progressing.'' | ||
* | * '''Submit a code patch''' [https://github.com/scummvm/scummvm/pulls via pull request] which follows our [[Commit Guidelines]]. Fix some known bug, extend functionality in some way, add a new unit test, or provide a start for the work you are applying for. Remember, this is an activity for the Summer of ''Code'' program, so while documentation improvements are always welcome, they don’t meet this requirement. | ||
''This is the basic entry bar to ensure that applicants are familiar enough with the code and concepts in ScummVM to submit a change. I.e., whether you manage to checkout the source '''(Git master)''', compile it, make a change, commit it, and then push it to github. Don't worry, though: It does not have to be anything complex, and you are highly welcome and even expected to ask us for help and guidance with this. Don't panic! In fact, finding out whether you communicate well with us and are willing to ask questions and learn is part of the test. There is a nice [http://panospace.wordpress.com/2009/03/25/a-patch-the-first-milestone/ blog post by Yuval Levy] from the [http://hugin.sourceforge.net/ hugin project], which explains the rationale behind this requirement.'' | ''This is the basic entry bar to ensure that applicants are familiar enough with the code and concepts in ScummVM to submit a change. I.e., whether you manage to checkout the source '''(Git master)''', compile it, make a change, commit it, and then push it to github. Don't worry, though: It does not have to be anything complex, and you are highly welcome and even expected to ask us for help and guidance with this. Don't panic! In fact, finding out whether you communicate well with us and are willing to ask questions and learn is part of the test. There is a nice [http://panospace.wordpress.com/2009/03/25/a-patch-the-first-milestone/ blog post by Yuval Levy] from the [http://hugin.sourceforge.net/ hugin project], which explains the rationale behind this requirement.'' | ||