wiki:GSoCApplicationTemplate

See the ideas list for some suggested project ideas. You are also most welcome to suggest your own ideas.

The GSoC website steers students towards creating proposals in Google Docs, but we've found this sub-optimal when it comes to reviewing proposals to offer feedback.

This year we're trying out an alternative approach - we've put a reStructured Text template in a git repo which you can clone. This involves tools which you'll need to be familiar with to successfully complete a project working on Xapian, such as a text editor, git, sphinx-doc and make). We can comment on proposals in the same way we review code submissions, and you can make changes in response to that and we can easily see what you've changed. The repo includes a makefile with a target to create a PDF version. We encourage you to use this template instead of Google Docs.

Quick walk-through:

  • Fork https://github.com/xapian/xapian-gsoc-proposal to your own github account.
  • Clone your fork to your local machine
  • Open proposal.rst in a text editor and fill it in - there are instructions in comments.
  • Commit your changes and push them.
  • Point us at the repo and we can review your proposal and offer feedback.
  • To generate a PDF for submitting on the GSoC website, run make pdf. You'll need some tools (such as sphinx-doc and LaTeX installed - you should already have installed if you've managed to build Xapian from git). You can upload a revised PDF at any point before the deadline, so don't leave your initial submission until the last minute.
Last modified 10 months ago Last modified on 12/03/18 10:24:17