|
| 1 | +# GSoC @ Arduino: Application Instructions |
| 2 | + |
| 3 | +## Before you apply |
| 4 | + |
| 5 | +If you are a student interested in submitting a proposal to CC, start by checking out our [Project Ideas](ideas.md) page to find an idea that you would like to write a proposal to work on during GSoC. |
| 6 | + |
| 7 | +Take a look at the [Arduino website](https://arduino.cc) to learn more about what we do. Also look at our GitHub organizations ([arduino](https://github.com/arduino) and [arduino-libraries](https://github.com/arduino-libraries)) and our [forum](https://forum.arduino.cc) to get a sense of the code and projects we work on. Making a successful contribution to one of our projects will help us get a sense of your work and is highly recommended. |
| 8 | + |
| 9 | +## Expectations |
| 10 | + |
| 11 | +### During the application phase |
| 12 | + |
| 13 | +_These tips can help your application! They are not strictly required._ |
| 14 | + |
| 15 | +* Read the official [GSoC student guide](https://google.github.io/gsocguides/student/) and the [GSoC FAQ](https://developers.google.com/open-source/gsoc/faq). |
| 16 | +* Review our [ideas list](ideas.md) and ask questions about projects you're potentially interested in on the [issue tracker](https://github.com/arduino/summer-of-code/issues) |
| 17 | +* Once you've decided on a project, follow these Application Instructions to write a draft proposal. |
| 18 | +* Experience shows that the best thing to help your application is to contact the organization you want to work with early. For this you can introduce yourself on our [GSoC issue tracker](https://github.com/arduino/summer-of-code/issues), and perhaps fix a small bug in our of our repositories and link it in your introductive post. |
| 19 | +* Get feedback from us before you submit a final application. |
| 20 | +* If you're proposing a project that's not on our official ideas list, please talk to us to see if there is any mentor interested in mentoring that project before you put any work into the proposal. |
| 21 | + |
| 22 | +### During the community bonding period |
| 23 | + |
| 24 | +* Continue to plan your project with your mentor and the community. |
| 25 | +* Get an Arduino (an original one!) and familiarize with it so that you know what you're working for. |
| 26 | + |
| 27 | +### During the summer |
| 28 | + |
| 29 | +* Write a short report for us every second week in a public forum topic. |
| 30 | +* Work 30-40 hours per week (or agree on a different plan with your mentor ahead of time). |
| 31 | +* Commit early and commit often! Push to a public GitHub repository so that we can see and review your work. |
| 32 | +* Actively work on our project timeline and communicate with us during the community bonding period. |
| 33 | +* Be available on Slack whenever you are working and post at least once a (work) day to talk about what you're working on that day. |
| 34 | +* If there is a reason why you can't work or can't contact us on a regular basis please make us aware of this in advance. |
| 35 | +* If you don't communicate with us regularly, we will fail you. |
| 36 | +* Set a realistic goal for all evaluation deadlines. If you fail to meet your own goal we are more likely to fail you in the evaluations. |
| 37 | +* Be proactive about asking for help, especially when you're stuck. |
| 38 | + |
| 39 | +## Applying |
| 40 | + |
| 41 | +### How to write a great proposal |
| 42 | + |
| 43 | +Your proposal must be submitted through the Google Summer of Code website. It is a good idea to submit drafts and get feedback from CC mentors before you submit your final proposal. |
| 44 | + |
| 45 | +Please read and follow the [GSoC student guide on writing proposals](https://google.github.io/gsocguides/student/writing-a-proposal). Also: |
| 46 | + |
| 47 | +* Don't be afraid to give us lots of detail about how you would approach the project. |
| 48 | +* Our application should make us believe that you are capable of completing the project and delivering the functionality to our users. If you aren't sure about anything, get in touch with us, we're happy to advise you. |
| 49 | + |
| 50 | +You can use our [base template](proposal-template.md) to draft your application in Markdown format. If you don't know what Markdown is, we recommend you familiarize with it anyway ;-) |
| 51 | + |
| 52 | +Your final proposal must be submitted to GSoC as a PDF file, so you can use Pandoc to generate one from your Markdown file: |
| 53 | + |
| 54 | +``` |
| 55 | +$ pandoc -f markdown -t pdf your-name.md |
| 56 | +``` |
0 commit comments