-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added the projects handbook, and updated the project template issue t…
…o include link to pitch
- Loading branch information
1 parent
9cec076
commit 20acb6d
Showing
2 changed files
with
184 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| # OHBM Brainhack 2024 Project handbook | ||
|
|
||
| ## Project submission | ||
|
|
||
| You can then submit a HackTrack project [here](https://github.com/ohbm/hackathon2024/issues/new?assignees=sina-mansour&labels=Hackathon+Project&projects=&template=brainhack-hacktrack-project.yml&title=%3CMy+Project+Name%3E). | ||
|
|
||
| We will ask you to provide some information about your project in order to advertise it and help onboarding new members. | ||
|
|
||
| If you have any questions on the way of submitting your project, feel free to open a general issue to ask any question. | ||
|
|
||
| This handbook includes more information on each item. | ||
|
|
||
| ### Hubs | ||
|
|
||
| The OHBM Brainhack 2024 will be hosted in Seoul for in-person participation, complemented by [3 online hubs](https://ohbm.github.io/hackathon2024/schedule/): | ||
|
|
||
| - Asia-Pacific (aligned with Seoul's time zone as the main hub) | ||
| - Europe, Middle East, Africa | ||
| - Americas | ||
|
|
||
| While your project may have leaders across multiple hubs, please note that live project pitches will occur once in the main hub. Additionally, some sessions will be shared with other hubs; for specifics, refer to the schedule. Consider recording your project pitch before the event to inform all virtual hubs. Moreover, we recommend identifying project leads to coordinate online contributions at different hubs to enhance hybrid collaborations. | ||
|
|
||
| ### Pitch Video | ||
|
|
||
| If your project welcomes hybrid/online participation, please create a brief project pitch for the Brainhack audience. The pitch should be relatively short (2-5 minutes) and will be presented on the first day of the event alongside other projects. For those attending in person, you may choose to deliver a live pitch, and for virtual participants, please upload the pitch video to YouTube and share the link with us. | ||
|
|
||
| ### Link to project | ||
|
|
||
| If your project involves code we recommend using a public repository (e.g. GitHub). | ||
|
|
||
| If your project does not involve coding, please include a link to the relevant documentation | ||
| (e.g. shared online document, space on the open science framework, etc.). | ||
|
|
||
| The repository should have [README.md](https://mozilla.github.io/open-leadership-training-series/articles/opening-your-project/write-a-great-project-readme/) containing: | ||
| - project idea and context; | ||
| - installation guidelines if applicable; | ||
| - links to further reading/tutorials; | ||
| - and if you want, additional files such as [Contributors.md](https://mozilla.github.io/open-leadership-training-series/articles/building-communities-of-contributors/write-contributor-guidelines/), to specify which types of people can contribute how. | ||
|
|
||
| ### Goals | ||
|
|
||
| Try to describe what you want to achieve during this brainhack. | ||
|
|
||
| If your project is just starting it might simply be "discuss, set up a roadmap, and identify potential obstacles". | ||
|
|
||
| For some other projects it could be a set of **SMART** goals: | ||
| - Specific (simple, sensible, significant). | ||
| - Measurable (meaningful, motivating). | ||
| - Achievable (agreed, attainable). | ||
| - Relevant (reasonable, realistic and resourced, results-based). | ||
| - Time bound (time-based, time limited, time/cost limited, timely, time-sensitive). | ||
|
|
||
| To keep track of the progress on the 2 issues of your project and all the sub-tasks you might use a kanban board. | ||
|
|
||
| A kanban board helps you manage your work in a very visual way: here is a short [video explaining the | ||
| idea](https://www.digite.com/kanban/what-is-kanban/). | ||
|
|
||
| You can use the integrated kanban on [GitHub](https://help.github.com/en/github/managing-your-work-on-github/about-project-boards) or use an external app like [trello](https://trello.com/). | ||
|
|
||
|
|
||
| ### Good first issues | ||
|
|
||
| If you have set up a repository for your code, it would be great if you open at least 2 `good first issues` | ||
| issues that describe the goals you would like to achieve in this brainhack. | ||
|
|
||
| Some examples: | ||
| - improve documentation or tutorial for a package | ||
| - fix an easy to truck bug | ||
| - add tests for specific features | ||
|
|
||
| ### Onboarding: skills | ||
|
|
||
| List skills that would be particularly suitable for your project. Skills can include coding skills and non-coding skills. | ||
|
|
||
| #### Non-coding skills | ||
|
|
||
| Think in particular about what different types of contributions could be? | ||
|
|
||
| It is not all about coding! Are you interested in collaborating with someone with a good flair for | ||
| good visualization? Someone with more experience who can make a good user interface? Someone who | ||
| knows how to develop good, tidy and clear documentation? | ||
|
|
||
| #### Example of Coding skills | ||
|
|
||
| ##### Programming languages | ||
|
|
||
|
|
||
| | language | level of expertise required | | ||
| |-------------------|-------------------------------| | ||
| | Python | beginner / confirmed / expert | | ||
| | JavaScript | beginner / confirmed / expert | | ||
| | C++ | beginner / confirmed / expert | | ||
| | Java | beginner / confirmed / expert | | ||
| | Unix command line | beginner / confirmed / expert | | ||
| | other | beginner / confirmed / expert | | ||
|
|
||
| ##### neuro-software specific skills | ||
|
|
||
|
|
||
| **MRI / fMRI** | ||
|
|
||
| | software | level of expertise required | | ||
| |------------|-------------------------------| | ||
| | SPM | beginner / confirmed / expert | | ||
| | FSL | beginner / confirmed / expert | | ||
| | Freesurfer | beginner / confirmed / expert | | ||
| | AFNI | beginner / confirmed / expert | | ||
| | ANTs | beginner / confirmed / expert | | ||
| | Nipype | beginner / confirmed / expert | | ||
| | other | beginner / confirmed / expert | | ||
|
|
||
| **EEG / MEG** | ||
|
|
||
| | software | level of expertise required | | ||
| |------------|-------------------------------| | ||
| | FieldTrip | beginner / confirmed / expert | | ||
| | Brainstorm | beginner / confirmed / expert | | ||
| | other | beginner / confirmed / expert | | ||
|
|
||
| ##### Data standards | ||
|
|
||
| | Standard | level of expertise required | | ||
| |-----------------------------|-------------------------------| | ||
| | Brain Imaging Data Structure| beginner / confirmed / expert | | ||
| | Neurodata Without Borders | beginner / confirmed / expert | | ||
| | other | beginner / confirmed / expert | | ||
|
|
||
|
|
||
| ##### Git skills | ||
|
|
||
| | level | description | | ||
| |---------|-----------------------------------------------------------------------------------| | ||
| | Git - 0 | no prior Git knowledge | | ||
| | Git - 1 | can commit and push to a repository | | ||
| | Git - 2 | comfortable working with branches and can do a pull request on another repository | | ||
| | Git - 3 | can work with continuous integration | ||
|
|
||
|
|
||
| ### Communication | ||
|
|
||
| Throughout the hackathon, we'll be utilizing [Discord](https://discord.com/). Kindly download the client and join our [OHBM space](https://discord.gg/yK8jakPfnG). Your project channel will be automatically generated. | ||
|
|
||
| For projects conducted online or in a hybrid format, please propose the meeting time on your Discord channel following the project kick-off pitch. | ||
|
|
||
| Consider scheduling a daily video meeting with your team members for effective communication. | ||
|
|
||
| If you're in Seoul, remain receptive to online contributors and actively monitor the Discord channel! | ||
|
|
||
|
|
||
| ### Credit and onboarding | ||
|
|
||
| How would your project onboard new members with different skillsets -- physicist/imager/clinician/psychologist/computational | ||
| scientist/maker/artist/lawyer -- as a project collaborator? | ||
|
|
||
| We recommend that you read through Mozilla Open Leadership material on | ||
| [personas](https://mozilla.github.io/open-leadership-training-series/articles/building-communities-of-contributors/bring-on-contributors-using-personas-and-pathways/) and [contribution guidelines](https://mozilla.github.io/open-leadership-training-series/articles/building-communities-of-contributors/write-contributor-guidelines/). | ||
|
|
||
| If you want to easily list contributors on your repository you can look into the [all contributors bot](https://github.com/all-contributors/all-contributors-bot). | ||
|
|
||
|
|
||
|
|
||
| ### Twitter-size summary of your project pitch | ||
| During the project pitch session, we will tweet about your project. Our default tweet will be as follows: | ||
|
|
||
| ``` | ||
| Title | ||
| Repo URL | ||
| Project leader Twitter handle | ||
| #OHBMHackathon #Brainhack #OHBM2024 #OHBM_Brainhack_2024 | ||
| ``` | ||
|
|
||
| Please provide a twitter-sized summary of your project if you would like us to tweet that instead of title. | ||
|
|
||
|
|