Skip to content

GSoC 2019: Proposal Template

Jump to bottom
Amit Patel edited this page Mar 25, 2019 · 8 revisions

Basic Details

  • Full Name
  • Location & Time Zone
  • Education/University
  • Email & Github Username
  • Skype Username
  • Website
  • Resume

Statement of Motivation

  • Why are you participating in Google Summer of Code?
  • Why did you choose AIMACode and AIMA Exercises?

Prior Experience

  • List your previous experience with HTML and Javascript. Have you used AIMA before?
  • Have you ever contributed to an open source project, if so, to which project(s)?

AIMACode Contributions

  • Have you contributed to AIMACOde before?
  • List all the onboarding tasks that you have completed.

Project Details

  • A brief overview of Student-Instructor workflow for AIMA Exercises
    • Mention various use-cases on how a student/instructor will interact with the platform: what they'll do
  • A detailed description of your proposed work.
    • Use flowcharts/diagrams for clarity.
    • Mention your deliverables for phase-1, phase-2 and final evaluations.

Tentative Timeline

  • Mention what you hope to achieve in the community bonding period.
  • Include a weekly timeline for your project starting from the coding period

Availability

  • Do you have any other commitments during the summer? (classes, exams, any other internship?)
  • How much time can you spend weekly on the project? (eg 30 hrs/week)
  • Would you be available for short weekly meetings? (yes/no?)

Useful Resources

  • AIMA Exercises onboarding tasks

  • GSoC official Timeline

  • How to write a good GSoC proposal

  • Sample GSoC Proposals (Sample 1, Sample 2)

  • Potential tasks that we look to work on for the summer.

    • Interface

      Refine the mechanism for showing answers and hints in both chapter-mode (the page that lists all exercises in the chapter) and exercise-mode (the page that shows only a single exercise).

    • Fix references Though some of the references are resolved, there are still many references that need to be linked properly

      Reference Type Description Desired behaviour on click/hover
      Page reference Refers a page from textbook Jump to page
      Chapter reference Refers a chapter from textbook Jump to chapter
      Section reference Refers a section from textbook Jump to reference
      External figure reference Refers an image outside exercise (in a chapter) Show image in a modal
      Internal figure reference Refers an image embedded within exercises Jump to image
      Equation reference Refers an equation Show equation in tooltip
      Exercise reference Refers and exercise Show exercise preview
      Citations Cites a paper Show reference in a tooltip

    • Allow users to bookmark certain questions

      Users should be able to select their favorite questions and access them later. Since these bookmarks are meant to be used for user's own reference, we can store them in browser's Localstorage. Students should be able to view their saved questions later in a side-panel.

    • Instructor tool to select certain exercises

      • It will be helpful for instructors to select certain exercises from the website and export them in raw text/Markdown/Jupyter Notebook/TeX/PDF format.
      • Once instructors have selected their questions, they can request the answers only for those questions. I believe solution-manual is not going to be public on GitHub, so we need to figure out a way to automate this process without manual intervention (and save you from sending the complete solution key individually).

    • Above all, we need to do performance load measurements to make sure AIMA Exercises will hold up under load.

Required Skills: User-interface design in HTML, CSS, Javascript;

Clone this wiki locally