_gsocproposals/YEAR/proposal_YOURPROJECTyourproposal.md(look at this example:
yearattribute is correct for your proposal
organization: YOURORGANIZATIONwill need to be referenced in the proposal and for each mentor
YOURNAME [YOUR@MAIL](mailto:YOUR@MAIL) YOURORGANIZATION
Every proposal must be attached to an organization (e.g. CERN, Fermilab…) and to a project (e.g. ROOT, GeantV…). If you add your own proposal yourself, be sure add the appropriate
project attributes (not case sensitive) in the front-matter section of the proposal. See next sections if you need to add a new organization or project but if you use an existing project and organization for your proposal you don’t have to do anything else that what was described above.
Proposals have to be tuned this year for either 175-hour or 350h project length. For 175h projects please propose coding topics having well-defined deliverables, rather than R&D with unforeseen timeline and results. Remember that your student will effectively work in total only about 30 days (6 hours/day) on the project!
Please do not forget to add essential information like level of difficulty, duration and an explicit statement about mentor availability.
Proposals are attached to a project (e.g. ROOT, CMS…). If you want to add a project for your proposal, you need to create
a Markdown file describing your project in
_gsocprojects/YEAR directory (must start with
look at HSF project for an example).
This is a very simple file, containing only a front matter section that defines the attributes of
your organization. The 2 mandatory attributes are
project (your project name) and
layout (which must be
In addition you can use 2 optional attributes:
title: the name of the project to use in the page title. By default,
projectattribute is used.
description: a description of your project that will be added before the list of proposals attached to the project.
It can be several lines: look at the example for detailed syntax. The content is a standard Markdown text indented by at least one space (the number is not important but must be the same for all lines).
logo: the logo file name in directory
images(please name your logo
PROJECTNAME-logo.pngand ensure it is less than 100kB)
A proposal is attached to a project by its attribute
project that must match (not case sensitive) the
attribute defined in project MD file. This attribute can be a single value or a list. For a list, use the following
syntax in the front matter section:
project: - ROOT - GeantV
Proposals are attached to an organization (e.g. CERN, Fermilab…). If you are a new organization, you need to create
a MD file describing your organization in
gsoc directory. This is a very simple file, containing only a
front matter section that defines the attributes of your organization.
A proposal is attached to an organization by its attribute
organization that must match (case insensitive) the
organization attribute defined in organization MD file. This attribute can be a single value or a list. For a
list, use the following syntax in the front matter section:
organization: - CERN - Fermilab
To create a new organization, copy _gsocorgs/2020/cern.md, create a file for your organization and edit its contents as appropriate.
Organization logos should be called
ORGANIZATION-logo.png and be less than 100kB in size.