TrustedUser
2,147
edits
Difference between revisions of "Summer of Code/Project Rules"
Summer of Code/Project Rules (view source)
Revision as of 21:02, 12 February 2018
, 21:02, 12 February 2018→Before you are accepted...: Indicate explicitly that we expect the patch to include more than just documentation changes
(gender neutral pronoun) |
(→Before you are accepted...: Indicate explicitly that we expect the patch to include more than just documentation changes) |
||
| Line 12: | Line 12: | ||
* ...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.'' | ||
* ...you are expected to '''submit a patch''' against our source code [https://github.com/scummvm/scummvm/pulls via a pull request from your own git repo fork]. Fix some known bug, extends functionality in some way, add a new unit test, or provide a start for the work you are applying for. | * ...you are expected to '''submit a patch''' against our source code [https://github.com/scummvm/scummvm/pulls via a pull request from your own git repo fork]. Fix some known bug, extends functionality in some way, add a new unit test, or provide a start for the work you are applying for. This should include modifications to the source code and modifying the documentation is not sufficient. Also your commits (and in particular, your commit messages) should adhere to our [[Commit Guidelines]]. | ||
** ''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.'' | ||