Edit this page

NWB Workshops and Hackathons

:rewind: Back to main page

What should my hackathon project look like?

Projects may span a broad range of topics, e.g., integrating new data with NWB, developing new features for PyNWB, exploring new problems, or creating documentation. Design your project in a way that:

  1. You can make significant progress during the hackathon (i.e., in ~1 day). This also means that you should come prepared for the hackathon. For example, if your project is about integrating data with NWB then you should a) know the data, b) ideally have scripts for reading the data in Python already prepared, and c) bring the data with you to the hackathon.
  2. The project is a) relevant to NWB and b) useful either as is or be something that you or someone else can build on after the hackathon

Does everyone need to have their own project?

Everyone should be part of a project, but not everyone must have their own project. Hacking in teams is fun!

How to create a new project

To ease collaborative editing of projects we are managing projects in the following Google Doc. To create a new project, simply:

  1. Open the Project Google Doc. If you are participating and do not have edit access, then please contact the workshop organizers via email or Slack to request access.
  2. Make a copy of the project template section and add it to the end of the document
  3. Update at least your project’s title, key investigators, and project description sections

Using GitHub pages

During previous events, we had used GitHub pages to manage projects. We generally encourage teams to use the Project Google Doc instead. However, if your team prefers to use GitHub pages to manage your project instead, then please follow the instructions below.

To create a new project page on GitHub, please create a new README.md file in a new subfolder of the projects folder using the provided [project template][template/] and add your project to the Project Google Doc. Step-by-step instructions for creating a new project using GitHub are:

  1. Open [project template][template/README.md] and copy its full content to the clipboard
  2. Go back to the projects folder on GitHub
  3. Click on “Create new file” button
  4. Type YourProjectName/README.md
  5. Paste the previously copied content of project template page into your new README.md
  6. Update at least your project’s title, key investigators, and project description sections
  7. Add a section with the title of your project to the Project Google Doc and include a link to your project page so that other teams can easily find your project.

Note: some steps above may require creating a pull request until your account is given write access.