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
Documentation Writing
Graphics Design
Electronics Engineering
Software Engineering

Not sure? That's okay, we also have some easier ways to contribute:

Reporting Bugs
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:

Writing & validating proofs
Developing new algorithms to improve design & efficiency
Quantum optics component design, validation, and testing
Quantum circuit simulations

Tools Used

Tool	Purpose	Recommended
LaTex Editor	Academic Writing	Texmaker
LaTeX Converter	Converting LaTex to PDF, Markdown, etc.	Pandoc
QuTiP	Quantum Mechanics Simulator	QuTiP

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:

Translations
Editing & proofreading
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:

Custom component design
Circuit analysis/Simulation
Schematic Design & Verification
PCB Layout & Verification
Gerber & assembly file verification (manufacturer specific)
Mixed-signal analysis
Integrity Analysis
Parts compatibility selection

Tools Used

Tool	Purpose
KiCAD	Schematic & PCB Design
GTKWave	Circuit Simulation
ngSpice	Spice Simulator

Software

TBD

Reporting Bugs

Experiencing a bug? Making a bug report is easy, just follow the instructions on the page.

New Ideas

Have a new idea? Submit it by making a Feature Request

Questions

Do you have questions about the project?

Check our F.A.Q.
Open a new Question

Steps To Contributing

Fork the project repo to your github
Clone the repo from your github
Create a development branch
Checkout development branch
Make changes
Submit pull request
???
Profit!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!