Merge pull request #12 from Spooky-Manufacturing/Development

Development

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,12 @@
+---
+name: Question
+about: Ask a questio about this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Did you search the [F.A.Q.]() First?**
+
+**What is your question?**

CONTRIBUTING.md

@@ -0,0 +1,100 @@
+# Contributing to 8Q
+
+First, thank you so much for taking the time to contribute to this project!
+
+[TOC]
+
+## How To Contribute
+
+There are many ways to contribute, and you don't need a PhD to do so, we've spec'd up a few pathways for contributing to help you get started:
+
+* [Academic](#academic)
+* [Documentation Writing](#documentation)
+* [Graphics Design](#graphics)
+* [Electronics Engineering](#electronics)
+* [Software Engineering](#software)
+
+Not sure? That's okay, we also have some easier ways to contribute:
+
+* [Reporting Bugs](#reporting-bugs)
+* [New Ideas](#new-ideas)
+
+### Academic
+
+There are many ways an academic can contribute to the project, below are just a few examples of the type of contributions that would really help this project:
+
+1. Writing & validating proofs
+2. Developing new algorithms to improve design & efficiency
+3. Quantum optics component design, validation, and testing
+4. Quantum circuit simulations
+
+#### Tools Used
+
+| Tool            | Purpose                                 | Recommended                                                  |
+| --------------- | --------------------------------------- | ------------------------------------------------------------ |
+| LaTex Editor    | Academic Writing                        | [Texmaker](https://www.xm1math.net/texmaker/)                |
+| LaTeX Converter | Converting LaTex to PDF, Markdown, etc. | [Pandoc](pandoc.org)                                         |
+| QuTiP           | Quantum Mechanics Simulator             | [QuTiP](http://qutip.org/docs/latest/guide/guide-overview.html) |
+
+### Documentation
+
+No project can survive without good documentation, and this project needs a lot of it! Documentation contributors help to not just orient newcomers, but also enable all teams to work together. Here are some of the contributions we're looking for:
+
+1. Translations
+2. Editing & proofreading
+3. Tutorial writing
+
+### Graphics
+
+Are you artistically inclined? Let your creativity roam free by creating graphics - instructional, educational, or just plain cool for the project! I don't really know much about graphic design, if you have any ideas feel free to share them! It would be really awesome if someone could design a nice logo for the project :)
+
+### Electronics
+
+Enjoy hardware hacking? Whether you're an expert in routing high-speed, differential signals or a complete beginner to electronics design, this project has room for you. The type of contributions we are looking for are:
+
+1. Custom component design
+2. Circuit analysis/Simulation
+3. Schematic Design & Verification
+4. PCB Layout & Verification
+5. Gerber & assembly file verification (manufacturer specific)
+6. Mixed-signal analysis
+7. Integrity Analysis
+8. Parts compatibility selection
+
+#### Tools Used
+
+| Tool               | Purpose                |
+| ------------------ | ---------------------- |
+| [KiCAD](kicad.org) | Schematic & PCB Design |
+| GTKWave            | Circuit Simulation     |
+| ngSpice            | Spice Simulator        |
+
+### Software
+
+TBD
+
+### Reporting Bugs
+
+Experiencing a bug? Making a [bug report](https://github.com/Spooky-Manufacturing/8Q/issues/new?assignees=&labels=&template=bug_report.md&title=) is easy, just follow the instructions on the page.
+
+### New Ideas
+
+Have a new idea? Submit it by making a [Feature Request](https://github.com/Spooky-Manufacturing/8Q/issues/new?assignees=&labels=&template=feature_request.md&title=)
+
+### Questions
+
+Do you have questions about the project?
+
+1.  Check our [F.A.Q.]() 
+2. Open a new [Question]() 
+
+## Steps To Contributing
+
+1. Fork the project repo to your github
+2. Clone the repo from your github
+3. Create a development branch
+4. Checkout development branch
+5. Make changes
+6. Submit pull request
+7. ???
+8. Profit!