This short tutorial will guide you on how to add a GSoC project idea in the OpenAstronomy website.
In case you face any issues with this tutorial do contact your org admins via email, Matrix, or in the mailing list.
tl;dr: are you an expert? Fork the repo and modify
the template file according to your idea, save it under
_projects/YYYY/sub-org/
with a meaningful filename and open a pull-request.
Everything you need is a title and description of the project idea, a set of requirements
for potential students (e.g., proficiency with astropy.tables
and astropy.units
),
and a list of potential mentors. In addition, please link any related issues or tickets
to the project idea, if any. Lastly, make sure to indicate the level of difficulty of
the project.
In case your project idea already has specific milestones, please add them so as to make students aware when they start writing their applications. If the project milestones are open ended and you would like to hear input from other members of the community, that is fine too!
Given that you have the above items, all you need now is to put them in a plain text file following
the template file (you may click on RAW
to see how it looks).
The file is composed in two parts (separated by a ---
).
Change the text in the template keeping special care of the structure of the yaml
file and the headings on the markdown part (e.g., the top level starts with a 4 level title: ####
).
If you are familiar with git/GitHub: for this repo and add your project idea to the directory of your sub-organisation. Otherwise, we've got you covered! Contact us via email and attach the above file.