Skip to content

GSoC_2020_deliverables

Lea Goetz edited this page May 5, 2020 · 2 revisions

This is a list of deliverables that every student will be evaluated against. If any of those points is not satisfied, the project will not be successful. Keep in mind that having fun is most important :)

Before GSoC starts (community bonding period)

The community bonding period is the time for planning. Required are

  • A detailed and concrete list of the goals and code deliverables of your project
  • A detailed and concrete schedule of how you want to achieve those goals
  • Design drafts in code, pseudo-code, or API diagrams of what you plan to implement.

During GSoC (3 months)

This is the time for doing.

  • Maintaining a personal GSoC page where you collect: schedule, PRs, blog posts.
  • Weekly short blog posts that you publish online, think of those as "status updates", i.e. "This is what I did, this is what went well/wrong, this is what I want to do next. The blog post after every of the three evaluations should be longer, and reflect on the previous weeks, re-using the shorter posts.
  • Continuous code development with at least two merged pull requests per week. These should be small, we don't like big pull requests.
  • A continuous, weekly update of your schedule: what has been done, what hasn't been done, how does that impact next week's work. It is possible to change initial goals with the mentor's consent.
  • Daily visibility and engagement with the community: daily stand-ups, presence in IRC and the mailing list
  • At least one merged PR outside your project: adding meta example & cookbook page, fixing an existing issue, etc.

At the end of GSoC (1-2 weeks before final evaluation)

  • All of your goals are implemented: code is merged, functional, tested, documented.
  • A written peer-review of a fellow student's work: usability, documentation, code-review.
  • A final longer blog post reflecting on the whole GSoC experience.

Acceptable

Don't worry if any of the below happen, but it is important that you bring this up early though.

  • You are stuck. Ask for help as soon as possible. This is fine. We will not accept statements like "I was stuck all of last week" though.
  • Your project goals change. All OK, as long as this is agreed with your mentor.
  • You have an unexpected personal situation that urgently requires you to stop working. We will do our best to be sympathetic on a case-by-case basis. However, we eventually cannot accept projects that don't deliver what they promised.

No-gos

These things will make your project fail. Please don't.

  • Being in-active during the community bonding period.
  • Going away for a week without having let us know in your application. We are fine with people taking a week (max!) off, as long as we know beforehand.
  • Disappearing for a week without anything produced.
  • Missing blog posts (weekly or long).
  • No weekly merged PR (adding examples and cookbook pages is easy, even if your project is stuck).
  • No visible progress in your project without you asking for help.
  • Violating our code of conduct will make your project fail immediately.
Clone this wiki locally