Skip to content

Latest commit

 

History

History
93 lines (54 loc) · 4.72 KB

schedule.md

File metadata and controls

93 lines (54 loc) · 4.72 KB
Raw

This document outlines what is expected of the projects and an initial schedule for the teams.

During the development of the projects we are going to put quite some emphasis into documentation, as a project is only properly open when its documentation allows others to:

  • Feel welcome to contribute.
  • Understand the current state of affairs in the project and make contributions.
  • Replicate what is being developed and adapt it for local needs/wishes.

Documentation will be done in GitHub. Please make sure you're familiar with its basics by going through any of the many available tutorials online (ex1, ex2, ex3, ex4).

Moreover, we will be developing scientific tools, which will hopefully reach a state where they can be:

  • Calibrated and tested against "traditional tools".
  • Published in a peer reviewed journal.

Communication

Some teams have suggested that we create a Slack to improve communications with other teams, and also make it an inviting space for other people interested in this project.

So here is an invitation link.

Interested people are welcome to join and introduce yourselves to the other teams in the #introductions channel!

Schedule

Week Products Call
Week 1 GitHub repo + related_work.md + draft BoM 1st call with mentor
Week 2 Order BoM + Dev Plan 2nd call with mentor
Week 3 Contributing.md + CoC + updates on development 3rd call with mentor
Weeks 4-7 Updates on development 4-7 calls with mentor
Week 8 Demo Group call

Week1:

  • Set up a github repository for your project, cloning the structure of our template repo.

  • in case needed, learn the basics of GitHub using the many tutorials online:

Dedicated for researchers general audience tutorials
Open Scapes has chapters dedicated to GitHub use for scientists: chapter 7 and Chapter 8 tutorial 1
Open Science MOOC also has content dedicated bring researchers to GitHub tutorial 2
tutorial 3
tutorial 4

Note: here are some other example repositories dealing with hardware: actifield, LightM.

Note 2: guidelines for a good readme by Mozilla can be found here and a good example here

  • Look up existing projects: find projects and resources available that can be useful for building your FOSH, so that you don't reinvent the wheel. Contact developers, maybe they would like to remotely contribute! Systematize these findings in related_work.md

  • Draft a bill of materials

  • First call with mentor

Week2:

  • Order parts listed in the Bill of Materials

  • Define a development plan following our template in dev_plan.md

  • Second call with mentor

Week3:

  • Add to the repository a contributing.md file and a code of conduct (Code_of_conduct.md) file

Note: guidelines for a good code of conduct by Mozilla can be found here and for contributor guidelines, here

  • Log advances and issues on repository - You can use GitHub's project boards tool

  • Third call with mentor

Weeks 4-7:

  • Log advances and issues on repository

  • 4-7th calls with mentor

Week 8:

  • Prepare a simple demo of your project
  • Join the group call
  • Celebrate :D