/TEMPLATE-project-repository

Clone this repository to kickstart documenting your Science Hack Day PDX 2017 project

TEMPLATE-project-repository

  1. Clone this repository to kickstart documenting your Science Hack Day PDX 2017 project

  2. Create an Issue in the Science Hack Day repository, and fill out the template form to link us to your project.

  3. Write a README.md document that describes your project.

  • What did you do?
  • What equipment, tools, software, and/or hardware did you use?
  • Who is this project for?
  • Can others contribute to your project?
  • Remember the confetti cannon - it's so sad when you find a confetti cannon but no one knows how to use it. Tradegies like these can be avoided by writing great documentation as you go!

  1. Don't be shy about sharing your code, project plan, or designs! Open Source is all about colaboration. Nothing is perfect, and that's ok! Done is better than perfect, so get it up on GitHub! Your code lives in the repository along with these text documents.

  2. Link out to a CONTRIBUTING.md guide that will show people how they can help.

  3. If your project is going to involve people, get everyone on the same page with a CODEOFCONDUCT.md.

  4. Is this just the beginning for your project? Write a ROADMAP.md to let contributors know where the project is going!