GSoC NIU Contributor Application Guidelines#

General tips#

These tips were originally based on the OpenAstronomy guidelines.

  1. Get in touch with the community

    Open source work is done and communicated in public - the idea here is to demonstrate that you can do this! Join our Zulip, or browse through our GitHub repositories - you can find a full list of the NIU repositories under the NIU GitHub organisation and the BrainGlobe one. Read, ask questions, get to know the people involved, and participate in discussions.

    Introduce yourself, and feel free to can ask questions about specific projects, the development process, recommended readings or the community. If you are not familiar with Zulip, have a look at this quick guide first.

    Although we love to hear from you, please don’t ask questions for the sake of “getting noticed”. We’re happy to help out, but we unfortunately cannot guide every potential applicant through the process.

  2. Become a user

    A great way to get started in the community of our open-source tools is to experience them as a user. Try to install and use our tools, experiment with the code, and report any issues you find. This will help you understand the tools better and will give you a better idea of what you can contribute.

    A good starting point as a user could be movement’s gallery of examples or BrainGlobe’s tutorials.

  3. Contribute to the community

    A key part of applying to GSoC is to get involved with the community, to show that you understand how the projects work, and that you would be able to contribute effectively during GSoC. In previous years, this would usually take the form of Pull Requests (PRs), to address open issues within NIU repositories. In the age of LLMs, writing code is no longer the bottleneck (and we struggle to review every PR we have!).

    PRs are still a great way to demonstrate your understanding of a project and show off your skills! If you want to contribute in this way, please make sure to:

    However, there are many other ways you can contribute, such as:

    • Raising issues to describe bugs within our tools (the more detailed the better)

    • Contributing to existing issues, e.g. by carrying out research to understand the best way to tackle an issue

    • Reviewing existing PRs

    In all cases, please think very hard about how you wish to contribute. Unfortunately, many unsolicited contributions can appear to be spam. A single, small, well-thought-out contribution that addresses a real need is far better than many superficial contributions. We want to see what specific skills you would bring to the project, not just that you can feed an issue into an LLM!

    Contributions

    However you contribute, please make only one contribution (PR, new issue etc.) until you have received feedback from a core NIU member. This helps make sure you’re on the right track, and gives us time to review everything properly. Making many contributions without waiting for feedback won’t strengthen your application, and may be treated as spam.

  4. Prepare your application

    Make sure you carefully read through the GSoC guidelines (and these guidelines!) when preparing your application.

    Select one of the projects from our project list and prepare a plan on how to tackle it, and the time you will need to complete it. Or if you have an idea that is not covered by the project list, feel free to pitch it to us. Use our application template to structure your proposal and don’t be shy to ask for feedback from the community. N.B. Applications not following this template will not be considered.

    Include specific examples in your application to support your skills - these will help reviewers build a better picture of you. These could be things like “Qualified in final round of XXXX” or “Participated in XXXX hackathon”.

  5. Submit your application

    Remember to submit your application before the deadline!

    Please do not send any applications directly to the NIU team, they won’t be considered - all applications must go through Google’s application system