Difference between revisions of "GSoC/2013/application-template"

(Reverting to last revision not containing links to *.net)
m (Reverted edits by Sperminator (talk) to last revision by Hrishikesh.kb)
 
Line 5: Line 5:
  
  
* Join the `SymPy mailing list
+
* Join the `SMC mailing list http://lists.smc.org.in/listinfo.cgi/discuss-smc.org.in. Introduce yourself over there so that the community can get to know you. Feel free to discuss your project ideas as well as to ask for any help that you may require.
<https://groups.google.com/group/sympy>`_ and introduce yourself.Not only
 
do we get to know you, but you can use the mailing list to get feedback on
 
project ideas and get help as you start working with the code base.
 
  
* Write and submit a proposal to the Google Summer of Codewebsite
+
* Prepare a detailed proposal regarding your project and submit it on the Google Summer of Code website (http://www.google-melange.com). You have to update the application in the Project wiki also(http://wiki.smc.org.in/)
(http://www.google-melange.com). If you want to, you can draft your project
 
proposal on our wiki (https://github.com/sympy/sympy/wiki/).This is not
 
required, but if you do, we will help you proofread it.See the section
 
below for how to name and link to your application so we can easily find it.
 
You may take a look at the old applications to see how they did things, links
 
to pages containing old applications can be found on the wiki main page.
 
 
 
* You will need to create an account on GitHub and send a patch.See below.
 
 
 
* If you need help with anything, ask on the `SymPy list
 
<http://groups.google.com/group/sympy>`_ or our IRC channel (`#sympy on
 
Freenode <irc://irc.freenode.net/sympy>`_) (don't be afraid if you don't
 
know git for example. We'll teach you everything that is needed, the only
 
required thing from you is enthusiasm and willingness to learn new things)
 
  
 +
* If you need help with anything, ask on the `SMC list http://lists.smc.org.in/listinfo.cgi/discuss-smc.org.in or our IRC channel (`#smc-project on Freenode http://webchat.freenode.net/?randomnick=0&channels=smc-project) (don't be afraid if you don't know git for example. We'll teach you everything that is needed, the only required thing from you is enthusiasm and willingness to learn new things,  but- '''don't expect spoon feeding from us''')
  
 
===Writing your proposal===
 
===Writing your proposal===
Line 32: Line 16:
 
http://www.google-melange.com/.
 
http://www.google-melange.com/.
  
If you want, you can start a wiki page to work on your proposal at
+
Start a wiki page to work on your proposal at
https://github.com/sympy/sympy/wiki/.If you add your proposal there, we will
+
http://wiki.smc.org.in/. Every applicant should create an account in SMC wiki. If you add your proposal under your userpage, we will help you edit it and provide feedback (though understand that we will not help you write it)
help you edit it and provide feedback (though understand that we will not help
 
you write it).You can add your application to our [[list of current
 
applications|GSoC-2013-Current-Applications]].To maintain a consistent naming
 
scheme, title your application: "GSoC 2013 Application <Your Name>: <Project
 
Name>".Old applications can be found either through the links on the main
 
page of the wiki or by browsing through [[_pages]].
 
 
 
Note that your final application must be submitted at
 
http://www.google-melange.com/, so do not worry about the formatting of your
 
application on the wiki, as you will have to reformat it there.You should
 
not be too concerned with the formatting in Melange either, as we understand
 
that the text editor there is not the best for making things look nice
 
formatting-wise.We are more concerned with the content of your application,
 
and that it is readable.
 
 
 
You may be able to get equivalent formatting in Melange from the wiki by
 
copying the webpage contents or messing with the HTML source, but you
 
shouldn't worry about it too much.
 
 
 
You should include the following information in your proposal:
 
 
 
'''You the person'''
 
 
 
 
 
Please put this information at the top of your proposal.
 
 
 
* Name
 
 
 
* University / current enrollment
 
 
 
* Short bio / overview of your background
 
 
 
* How can we contact you (email, IRC handle, GitHub username, Google Code
 
username, etc.)?This information will help us associate all of your
 
various usernames with you.
 
 
 
'''You the programmer'''
 
 
 
 
 
In your project proposal let us know about your programming experience.Don't
 
worry if you don't know SymPy or git.Many of our students start fresh.
 
We will teach you what you need to know.
 
 
 
* What platform do you use to code?What editor do you prefer and why?
 
 
 
* What is your experience programming?Tell us about something you have
 
created.
 
 
 
* What is your experience with Python?What are your favorite features of
 
Python that are lacking in most other common programming languages?What,
 
in your opinion, is the most advanced Python language feature or standard
 
library functionality that you have used?
 
 
 
* What is your favorite feature of SymPy?Demonstrate it here with a cool example.
 
 
 
* Have you ever used git or another version control system?
 
 
 
 
 
'''You and your project'''
 
  
 +
Note that your final application must be submitted at http://www.google-melange.com/, so do not worry about the formatting of your application on the wiki, as you will have to reformat it there.You should not be too concerned with the formatting in Melange either, as we understand that the text editor there is not the best for making things look nice formatting-wise.We are more concerned with the content of your application, and that it is readable.
  
Answer the following questions in your proposal:
 
  
* What do you want to achieve?
+
'''The application template is given below'''
 +
-----
  
* What excites you about this project?Why did you choose it?
+
====Personal information====
 +
* Email Address:
 +
* Telephone: '''No Need to Provide Phone Number in Wiki since it is going to be public'''
 +
* Blog URL:
 +
* Freenode IRC Nick:
 +
* Your university and current education:
 +
* Why do you want to work with the Swathanthra Malayalam Computing?
 +
* Do you have any past involvement with the Swathanthra Malayalam Computing or another open source project as a contributor?
 +
* Did you participate with the past GSoC programs, if so which years, which organizations?
 +
* Do you have other obligations between May and August ? Please note that  we expect the Summer of Code to be a full time, 40 hour a week  commitment
 +
* Will you continue contributing/ supporting the Swathanthra Malayalam Computing after the GSoC 2013 program, if yes, which area(s), you are interested in?
 +
Why should we choose you over other applicants?
  
* What qualifications do you have to implement your idea?For example, if you
+
====Proposal Description====
are implementing solvers for partial differential equations, what courses
+
Please describe your proposal in detail.
have you taken or books have you read on PDEs?Why are you suited to work on
 
this project?
 
  
* What have other people done on this idea?Has it been implemented before?
+
'''NOTE''': Please do not verbatim copy text from the ideas page, or from other people's
(hint: it probably has)Are there any papers or blog posts about it?
 
 
 
* How much time do you plan to invest in the project before, during, and after
 
the Summer of Code? (we expect full time 40h/week during GSoC, but better
 
make this explicit) If you plan to take any vacations over the summer, let
 
us know about it here.
 
 
 
* Please provide a schedule of how this time will be spent on sub-tasks
 
of the project over the period of the summer. While this is only
 
preliminary, we will use it to help monitor your progress throughout
 
the program.Also understand that during the project you will issue
 
weekly progress reports against that plan on your blog.
 
 
 
* In planning your project, it is good to note where along the way you could
 
formulate a pull request. These would be points where you can have a self
 
contained and well documented and tested piece of functionality. Doing this
 
at several points during the summer helps to keep branch merges reasonable
 
and code reviews manageable. A big code dump at the end of the summer will
 
likely be hard to review and merge before the project deadline.
 
 
 
* Please do not verbatim copy text from the ideas page, or from other people's
 
 
discussions about your project, but rewrite it in your own words.If you
 
discussions about your project, but rewrite it in your own words.If you
 
include any significant text or code from another source in your
 
include any significant text or code from another source in your
application, it must be accompanied with a proper citation.All papers or
+
application, it must be accompanied with a proper citation. All papers or
references that you use or plan to use must also be cited.Put all this in
+
references that you use or plan to use must also be cited. Put all this in
 
a "References" section at the bottom of your application.
 
a "References" section at the bottom of your application.
  
You do not need to format your application as a question/answer format
+
'''Include''':
for the above questions, but we expect to see all of the above questions
+
*  An overview of your proposal
answered in your application somewhere.
+
*  The need you believe it fulfills
 
+
*  Any relevant experience you have
'''Patch requirement'''
+
*  How you intend to implement your proposal
 
+
* A rough timeline for your progress with phases
 
+
*  Any other details you feel we should consider
In addition to the written proposal, we require every GSoC applicant to write a
+
*  Tell us about something you have created.
patch and get it pushed into our current master. To do this:
+
*  Have you communicated with a potential mentor? If so, who?
 
+
*  SMC Wiki link of your proposal
* Set up your platform to develop with SymPy (install git, clone
 
https://github.com/sympy/sympy.git, execute tests). The page on our
 
[[Development-workflow]] will walk you through setting up git and lays out
 
our preferred way of development.
 
  
* Create an account at GitHub and fork SymPy (https://github.com/sympy/sympy).
+
-----
  
* Find something in SymPy that doesn't work or needs improvement and send us a
+
====Other requirements====
git patch fixing it. If you need inspiration, feel free to fix any issue
+
''' Make sure you have completed following task to get qualified, failing to complete any task will results in rejecting your application.'''
from our `easy to fix issues list
 
<http://code.google.com/p/sympy/issues/list?q=label:EasyToFix>`_. Aside from
 
the issues, search for ``FIXME`` or ``TODO`` in the code. You can grep from
 
the command line with the following: ``grep -r -H "TODO"`` . You could also
 
search for NotImplementedErrors and XFAILs).You could also play with SymPy
 
and find something that needs fixing or that could be implemented, and do
 
it.
 
  
* Your patch must be code-related, not documentation. If your project will use
+
* You have subscribed with the [http://lists.smc.org.in/listinfo.cgi/discuss-smc.org.in SMC mailinglist] (and [http://lists.nongnu.org/mailman/listinfo/silpa-discuss SILPA mailinglist] for SILPA projects)
a language other than Python (e.g., JavaScript), you should submit patches
+
* Your application is available on [http://wiki.smc.org.in/ SMC Project wiki] under your userspace
that use that language as well, so that we know that you know you are
+
* Your application is submitted to google-melange
proficient in that language.
 
  
* Report success on the SymPy list
+
In addition to the written proposal, we require every GSoC applicant to do this:
 +
* Do create an account on the SMC wiki and start a wiki page for your proposal(Under your userpage). Keep it updated.
 +
* We expect every GSoC participant to maintain a blog (If not, already) and post about their project's status, development, etc.
 +
* Update the project status in the mailing list regularly with a meaningfull subjectline (don't use something like 'GSoC Project Update ')
  
* Publish your patch for peer review by creating a pull request on GitHub.
 
You must submit a patch that is successfully reviewed and pushed in to be
 
accepted. We do not consider applications without patches. This shows us that
 
you know Python and that you are able to interact with the community.
 
Furthermore, your patch must go through a GitHub pull request (as opposed to
 
a patch file on an issue, for example), as this is not only the easiest way
 
for us to review your code, but is also what we expect from a student working
 
on a GSoC project.
 
  
* **In your application, please provide a brief summary of your contributions to
+
'''Useful Links'''
SymPy so far, including unmerged work. At at least one link to a merged pull
 
request proving that you satisfied the patch requirement.**
 
  
* Note that because we may be slow to review the pull requests, you do not
+
* [http://www.google-melange.com/gsoc/document/show/gsoc_program/google/gsoc2013/help_page# GSoC FAQ]
have to have your request merged by the application deadline (though you
+
* [http://www.google-melange.com/gsoc/events/google/gsoc2013 Timeline]
should try to do it if you can!).But you do need to at least have one
+
* [http://en.flossmanuals.net/GSoCstudentguide/ GSoC Student manual]
submitted by then.We will give priority to reviewing requests that are
+
* [http://en.flossmanuals.net/melange/students-students-application-phase/ Melange manual - Student application Phase ]
needed to satisfy patch requirements.It is up to you to respond to our
 
feedback in a timely enough manner so that your patch gets merged before the
 
acceptance deadline.
 

Latest revision as of 05:26, 26 January 2017

GSoC 2013 Application Template

Things to do

Writing your proposal

To be considered, a GSoC application must have a written proposal submitted to http://www.google-melange.com/.

Start a wiki page to work on your proposal at http://wiki.smc.org.in/. Every applicant should create an account in SMC wiki. If you add your proposal under your userpage, we will help you edit it and provide feedback (though understand that we will not help you write it)

Note that your final application must be submitted at http://www.google-melange.com/, so do not worry about the formatting of your application on the wiki, as you will have to reformat it there.You should not be too concerned with the formatting in Melange either, as we understand that the text editor there is not the best for making things look nice formatting-wise.We are more concerned with the content of your application, and that it is readable.


The application template is given below


Personal information

  • Email Address:
  • Telephone: No Need to Provide Phone Number in Wiki since it is going to be public
  • Blog URL:
  • Freenode IRC Nick:
  • Your university and current education:
  • Why do you want to work with the Swathanthra Malayalam Computing?
  • Do you have any past involvement with the Swathanthra Malayalam Computing or another open source project as a contributor?
  • Did you participate with the past GSoC programs, if so which years, which organizations?
  • Do you have other obligations between May and August ? Please note that we expect the Summer of Code to be a full time, 40 hour a week commitment
  • Will you continue contributing/ supporting the Swathanthra Malayalam Computing after the GSoC 2013 program, if yes, which area(s), you are interested in?
  • Why should we choose you over other applicants?

Proposal Description

Please describe your proposal in detail.

NOTE: Please do not verbatim copy text from the ideas page, or from other people's discussions about your project, but rewrite it in your own words.If you include any significant text or code from another source in your application, it must be accompanied with a proper citation. All papers or references that you use or plan to use must also be cited. Put all this in a "References" section at the bottom of your application.

Include:

  • An overview of your proposal
  • The need you believe it fulfills
  • Any relevant experience you have
  • How you intend to implement your proposal
  • A rough timeline for your progress with phases
  • Any other details you feel we should consider
  • Tell us about something you have created.
  • Have you communicated with a potential mentor? If so, who?
  • SMC Wiki link of your proposal

Other requirements

Make sure you have completed following task to get qualified, failing to complete any task will results in rejecting your application.

In addition to the written proposal, we require every GSoC applicant to do this:

  • Do create an account on the SMC wiki and start a wiki page for your proposal(Under your userpage). Keep it updated.
  • We expect every GSoC participant to maintain a blog (If not, already) and post about their project's status, development, etc.
  • Update the project status in the mailing list regularly with a meaningfull subjectline (don't use something like 'GSoC Project Update ')


Useful Links