Skip to content

Commit 4cf9dac

Browse files
authored
GSoC guidelines and application template edits (#121)
* Add DPS feedback * Add links to repos in project lists * Add Adam's feedback * Fix link * Support project proposals * Add NIU wiki * Clarify wiki procedure
1 parent 2b88ad4 commit 4cf9dac

File tree

6 files changed

+29
-13
lines changed

6 files changed

+29
-13
lines changed

docs/source/get-involved/gsoc/guidelines.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ These tips are largely based on the [OpenAstronomy guidelines](https://openastro
77

88
Open source work is done and communicated in public - the idea here is to demonstrate that you can do this! Join our [Zulip](https://neuroinformatics.zulipchat.com/), or browse through our GitHub repositories - you can find a full list of the NIU repositories under the [NIU GitHub organisation](https://github.com/neuroinformatics-unit) and the [Brainglobe](https://github.com/brainglobe) one. Read, ask questions, get to know the people involved, and participate in discussions.
99

10-
Just introduce yourself, and feel free to can ask questions about specific projects, the development process, recommended readings or the community.
10+
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](https://zulip.com/help/getting-started-with-zulip) first.
1111

1212
2. **Become a user**
1313

1414
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.
1515

16-
A good starting point as a user could be `movement`'s gallery of [examples](https://movement.neuroinformatics.dev/examples/index.html) or BrainGlobe's [tutorials](https://brainglobe.info/tutorials/index.html).
16+
A good starting point as a user could be `movement`'s [gallery of examples](https://movement.neuroinformatics.dev/examples/index.html) or [BrainGlobe's tutorials](https://brainglobe.info/tutorials/index.html).
1717

1818
3. **Get ready to be a developer**
1919

@@ -27,12 +27,14 @@ These tips are largely based on the [OpenAstronomy guidelines](https://openastro
2727
- [Oh my git!](https://ohmygit.org/) an open-source game about Git.
2828
- [Julia Evan's How Git Works! zine](https://jvns.ca/blog/2024/04/25/new-zine--how-git-works-/)
2929
- the [NIU's software skills courses](https://software-skills.neuroinformatics.dev/courses/index.html)
30+
31+
We can help you with this if needed! Reach out in a relevant Zulip topic (or open one) if you have any questions, and someone from the community will be happy to help you.
3032

3133
4. **Get started with open-source development**
3234

3335
Check the GitHub issues for the projects you are interested in. Sometimes issues are labeled as "good first issue" or "help wanted". These are usually easier to solve and are a good way to get started with the project. Otherwise, have a look and see if there are any issues you can help with!
3436

35-
You will be expected to submit a pull request (ideally to one of the NIU projects) before you submit your application. It does not have to be accepted - the goal is to show that you know how git, GitHub, pull requests and code reviews work. This also allows mentors to evaluate your applications beyond a pdf, and based on a real code contribution. If you have previously contributed to an NIU or other open source project, you can point to those pull requests in your application too.
37+
You will need to submit a pull request (ideally to one of the NIU projects) as part of your application. It does not have to be accepted - the goal is to show that you know how git, GitHub, pull requests and code reviews work. This also allows mentors to evaluate your application based on a real code contribution. If you have previously contributed to an NIU or other open source project, you can point to those pull requests in your application too.
3638

3739
If you are new to open source software or would like a refresher, these are some nice resources to check:
3840

@@ -41,12 +43,23 @@ These tips are largely based on the [OpenAstronomy guidelines](https://openastro
4143

4244
Before contributing to a project, make sure you read through their contributing guidelines. These will give you an idea of the required steps, and what is expected of you. An example is `movement`'s [How to Contribute guide](https://movement.neuroinformatics.dev/community/contributing.html#target-contributing). The NIU also publishes some general [development guidelines](https://neuroinformatics.dev/get-involved/languages_frameworks.html).
4345

46+
You can check the issues from the tools involved in the GSoC projects in the links below:
47+
- [`movement` issues](https://github.com/neuroinformatics-unit/movement/issues)
48+
- [`ethology` issues](https://github.com/neuroinformatics-unit/ethology/issues)
49+
- [`BrainGlobe cellfinder` issues](https://github.com/brainglobe/cellfinder/issues)
50+
- [`BrainGlobe brainrender` issues](https://github.com/brainglobe/brainrender/issues)
51+
- [`BrainGlobe atlasaip` issues](https://github.com/brainglobe/brainglobe-atlasapi/issues)
52+
- [`BrainGlobe registration` issues](https://github.com/brainglobe/brainglobe-registration/issues)
53+
- [`datashuttle` issues](https://github.com/neuroinformatics-unit/datashuttle/issues)
54+
4455

4556
5. **Prepare your application**
4657

4758
Make sure you carefully read through the [GSoC guidelines](https://google.github.io/gsocguides//student/writing-a-proposal) (and these guidelines!) when preparing your application.
4859

49-
Select one of the projects from our [project list](projects_2025/index) and prepare a plan on how to tackle it, and the time you will need to complete it. Use our [application template](#application-template) to structure your proposal and don't be shy to ask for feedback from the mentors or the community.
60+
Select one of the projects from our [project list](projects_2025/index) 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](#application-template) to structure your proposal and don't be shy to ask for feedback from the community.
61+
62+
To discuss your project proposal with the us, please create a new page in the [NIU GitHub wiki](https://github.com/neuroinformatics-unit/gsoc/wiki) with the project title prefixed with "GSoC 2025:" - we will discuss and polish your idea there. Please note that project proposals that are not previously discussed in the wiki will not be considered.
5063

5164
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".
5265

@@ -55,7 +68,7 @@ These tips are largely based on the [OpenAstronomy guidelines](https://openastro
5568

5669
Remember to submit your application before [the deadline](https://developers.google.com/open-source/gsoc/timeline#april_8_-_1800_utc)!
5770

58-
Please do not send any applications directly to the NIU team - all applications must go through [Google's application system](https://summerofcode.withgoogle.com/)
71+
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](https://summerofcode.withgoogle.com/)
5972

6073

6174
## Application template
@@ -64,6 +77,9 @@ Please use the following template to submit your application to the NIU GSoC 202
6477

6578
The more closely you follow this template, the easier it will be for us to review your application! Please include clear headings for all the different sections.
6679

80+
### Project title to use for the GSoC application
81+
Please clearly include in the title the tool the project refers to, and the title of the project you are applying for. E.g. "movement: support for Kalman filters".
82+
6783
### Personal details
6884
Please include the following information:
6985
- **Full name** (include preferred name if desired)
@@ -74,13 +90,12 @@ Please include the following information:
7490
- **Personal website / project portfolio** (optional)
7591
- **Code contribution**
7692

77-
Please link a pull request or code sample, ideally submitted to your chosen project. It must be publicly visible and represent your own work, although you may have help from other developers in the community to further improve it. You can link more than one contribution or pull request if desired.
93+
Please link a pull request, ideally submitted to your chosen project or one of the NIU tools. Applications without a code contribution won't be considered. It must be publicly visible and represent your own work, although you may have help from other developers in the community to further improve it. It must be meaningful code contribution (i.e. not just fixing a minor spelling mistake). While AI tools (such as Copilot etc) can be a very useful, contributions mostly created by AI are unlikely to be useful, and will not be accepted. You can link more than one pull request if desired.
7894

7995
### Project proposal
8096
Extension: <u> max 1 page </u>
81-
8297
- **Title.**
83-
Please clearly include the title of the project you are applying for and the tool it refers to. E.g. "movement: support for Kalman filters".
98+
Please use the same title as in the GSoC application.
8499

85100
- **Synopsis.**
86101
Briefly explain: what is the project about? Why is it important? What are the goals? What are the deliverables? How would the open source community benefit from this project?

docs/source/get-involved/gsoc/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ You may also want to checkout other useful application guides, such as:
6565

6666
all of which we are closely following. Applicants are given about 2 weeks to complete their applications. For further details see the [GSoC Contributor Guide](https://google.github.io/gsocguides/student/writing-a-proposal).
6767

68-
If you are interested in any of the NIU projects on offer, feel free to get in touch with us via [Zulip](https://neuroinformatics.zulipchat.com/) with any questions. Potential GSoC contributors are encouraged to get in touch with participating organizations as soon as the list of accepted organizations is published (this year, on the [27th February 2025](https://developers.google.com/open-source/gsoc/timeline#february_27_-_1800_utc)).
68+
If you are interested in any of the NIU projects on offer, feel free to get in touch on the relevant project channel via [Zulip](https://neuroinformatics.zulipchat.com/) with any questions. Please reach out in public channels, rather than via DMs or personal conversations - communicating in the open is a big part of open source! However, if you have any concerns you wish to discuss privately (such as accessibility), please contact one of the organisation admins.
6969

7070
For clarity, please always use your full name when getting a [Zulip](https://neuroinformatics.zulipchat.com/) account, when registering for the program, and when submitting your project plan.
7171

docs/source/get-involved/gsoc/projects_2025/brainglobe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# GSoC NIU Projects 2025: BrainGlobe
22

33
[BrainGlobe](https://brainglobe.info) is a community-driven suite of open-source Python tools. The BrainGlobe tools are widely used to process, analyse and visualise images of brains (and other related data) in neuroscientific research.
4-
If you are interested in any of these projects, [get in touch](https://brainglobe.info/contact.html)! Feel free to open a new topic on [Zulip](https://brainglobe.zulipchat.com/) and tag the potential mentors.
4+
If you are interested in any of these projects, [get in touch](https://brainglobe.info/contact.html)! Feel free to open a new topic on [Zulip](https://brainglobe.zulipchat.com/) and ask the community.
55

66
Our working language is English, but our mentors for these projects also speak Italian, French, and German.
77

docs/source/get-involved/gsoc/projects_2025/datashuttle.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# GSoC NIU Projects 2025: `datashuttle`
22

3-
If you are interested in any of these projects, [get in touch](https://datashuttle.neuroinformatics.dev/pages/community/index.html)! Feel free to open a new topic on [Zulip](https://neuroinformatics.zulipchat.com/#narrow/channel/405999-DataShuttle) and tag the potential mentors.
3+
If you are interested in any of these [datashuttle](https://github.com/neuroinformatics-unit/datashuttle) projects, [get in touch](https://datashuttle.neuroinformatics.dev/pages/community/index.html)! Feel free to open a new topic on [Zulip](https://neuroinformatics.zulipchat.com/#narrow/channel/405999-DataShuttle) and ask the community.
4+
45
Our working language is English.
56

67

docs/source/get-involved/gsoc/projects_2025/ethology.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GSoC NIU Projects 2025: `ethology`
22

3-
If you are interested in any of these projects, get in touch! Feel free to open a new topic on [Zulip](https://neuroinformatics.zulipchat.com/#narrow/channel/483869-Ethology) and tag the potential mentors.
3+
If you are interested in any of these [ethology](https://github.com/neuroinformatics-unit/ethology) projects, get in touch! Feel free to open a new topic on [Zulip](https://neuroinformatics.zulipchat.com/#narrow/channel/483869-Ethology) and ask the community.
44

55
Our working language is English, but our mentors for these projects also speak Spanish.
66

docs/source/get-involved/gsoc/projects_2025/movement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GSoC NIU Projects 2025: `movement`
22

3-
If you are interested in any of these projects, [get in touch](https://movement.neuroinformatics.dev/community/index.html)! Feel free to open a new topic on [Zulip](https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement) and tag the potential mentors.
3+
If you are interested in any of these [movement](https://github.com/neuroinformatics-unit/movement) projects, [get in touch](https://movement.neuroinformatics.dev/community/index.html)! Feel free to open a new topic on [Zulip](https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement) and ask the community.
44

55
Our working language is English, but our mentors for these projects also speak Spanish.
66

0 commit comments

Comments
 (0)