Skip to content

GSoC Final Submission Guidelines

Daniyal Jahan Warsi edited this page Aug 15, 2019 · 5 revisions

Requirements of a Good Report

  • Report is available on a public and a stable location.
  • Code should be well documented.
  • Make sure the project has good user documentation.
  • If changes were requested in any of the Pull-Requests, then make sure to resolve the change request.

Students are advised to use one of the following options for final submission of report.

Link to a single Pull-Request in GitHub

  • Make sure the first line in the description of PR clearly states the GSoC project name and year.
  • Give a detailed description of your implementations and the work done during GSoC.
  • If work is not 100% complete then mention what still needs to be done.
  • If more work will be done to this PR in the future, then clearly note the latest commit which was part of the final submission.
  • [Optional] - Link to live project.

Blog post or web page or public GitHub gist

  • Should clearly describe the work done during GSoC.
  • Should be publicly accessible and it should not be changed post the submission period.
  • If work is not 100% complete then mention what still needs to be done.
  • Link to the Pull-Requests/commits.
  • [Optional] - Link to live project.
  • [Optional] - Challenging parts of the project and how you tackled it.

Dont's

  • Link to a tarball/zipfile containing the entire project's source code or your working directory.
  • Link to the top of the project's primary source repository. I.e. Do not submit the link to GraphSpace: https://github.com/Murali-group/GraphSpace
  • Link to your clone of the project's source repository. This makes it hard to see what your changes are because your work is mixed with others.
  • Link to your GSoC project page. We already know what that is. (i.e. https://summerofcode.withgoogle.com/projects/#1234567890)
Clone this wiki locally