Hi! Thanks for taking the time to read through this project and for your interest in collaborating.
There are several ways to contribute to this project and you can find some suggestions below, there are basically no requirements for collaborations, but we suggest that people interested in the project:
-gather a basic knowledge on Git (version control system used for this project) -learn how to make collaborations using Github (the current platform hosting this project).
Here are some tutorials for both things:
-https://product.hubspot.com/blog/git-and-github-tutorial-for-beginners
-https://learn.co/lessons/git-github-and-learn
-https://guides.github.com/activities/hello-world/
This might make the entry barrier a bit higher, but it will allow a much easier workflow, allow collaborators to try and test as much as they want in their local copies of the project, and a better management of the entire project, since we can track its history, the issues that need to be solved and the things we need to add based on popular demand.
If you have any questions about using git/github in this project, please open up an issue and we will try to help the best way we can to get you setup and running!
- OBS: Some git jargon is used in this document as we are assuming collaborators accepted our suggestion above ;)
Do you speak another language other than English? Consider translating the survey so that non-English speakers can also share their scientific hardware needs!
- The best way to contribute here is to fork this repo, create the translation and then make a pull request.
Do you like playing with data? Take a look at the Jupyter notebook being used to do analysis! This way we can better visualize the data and have a better idea what things are necessary and where.
-
The best way to contribute here is to fork this repo, change the code and then make a pull request.
- Please make sure your code is properly commented and that variable names are as self-explanatory as possible. Keep in mind that people with different backgrounds and coding skill levels are involved! Coding with more simple steps is preferred over complicated "one liners" (even if they are more efficient).
Do you love hardware development? Find a piece of the hardware in the "needed instruments" list and:
- go to the respective repository! There you'll find ways to contribute and what help is needed, since this will change given the development stage of the device.
- If a repository is not there yet, get in touch by adding an issue to this repo stating what hardware you would like to develop! We will then get in touch and offer as much support as needed to get you going :)
Would you like to use/test what is being developed? Get in touch by opening up an issue, this way we can best support you in building/testing and trouble shooting.