Hacker Guide
No matter your experience in quantum tech or open source communities, you can help make quantum open source better (and get PAID!). This guide will help you understand more about the event and how you can make the most of it!
ποΈ Hacker Timeline ποΈ
- ASAP: Sign up for unitaryHACK!
- May 21st: unitaryHACK Q&A event on Discord at 9:30 am Pacific Time.
- June 11th 5pm AoE: Deadline to submit pull requests.
- June 20th: Awardees finalized and contacted.
β Before the Hack β
REGISTER HERE! You'll need to be registered in order to receive awards.
Brush up on your open source contribution skills
- How to Contribute to Open Source
- GitHub Training Kit
- Understanding the GitHub Flow
- How open source contributions can boost your career
- How to write the perfect pull request
- How to write a good commit message
- Practice making a GitHub Contribution
Review the tech
Whether you are new to quantum technologies or work on them every day, here is a good list of general quantum computing resources that might be helpful to learn with or brush up on:
- Quantum Open Source Learning Resources on Quantum Computing
- IBMβs Quantum Learning Resources
- Quantum Machine Learning / PennyLane Tutorials
π¨ During the Hack π¨
Join the discord
The main place that will be most helpful to you while you hack is connecting with other hackers and maintainers on the Unitary Foundation Discord. You can find folks from the Unitary Foundation to ask about rules, as well as maintainers of the participating projects, and other hackers who might be able to lend a hand or team up (totally encouraged)!
Find a task to dive into
Once you have found a project you want to work on, find an issue on that project you want to lend a hand on. This could be one of the special bountied issues (meaning if you submit a maintainer accepted solution for these we will send you cash), or any other issue on that repo. Pay special attention to issues tagged unitaryHACK as they are ones the project maintainers have flagged as particularly good for contest participants to tackle.
If you want to team up with other hackers on an issue that you have found, you can make a comment on the GitHub issue. Even if you don't plan to team up, commenting on GitHub may help other hackers know if someone else is working on that issue (that's fine, but depending on the issue, only one pull request may be merged to solve an issue). We ask that you not comment on more than 3-4 projects per day. This is to ensure that you are not overwhelming yourself, the maintainers, or your fellow hackers.
Make a pull request
Once you have a good solution to the issue, and have checked out the project's contributing guide (if they have one), you are ready to make your pull request! Check out the guides above if you are not familiar with git
or GitHub, or if you run into issues making the contribution, just ask on the Unitary Foundation discord!
We ask that you not create more than 4 pull requests at one time. This is to ensure that you are not overwhelming yourself, that other hackers are getting a chance to contribute, and that our maintainers are not inundated with PRs that arenβt fully complete.
If your pull request is accepted, in order for our bots to find it you'll need the project maintainers to assign the issue to you. If it's your first time contributing to the project, you'll need to comment on the issue in order to be "assignable". Please note that being assigned an issue does not mean that others cannot be assigned and other participants may be working on the same issue. We ask that you not comment on more than 3-4 projects per day. This is to ensure that you are not overwhelming yourself, the maintainers, or your fellow hackers.
π After the Hack π
If you claimed any bounties, we will be in touch via email after unitaryHACK to coordinate payment, so make sure you sign up so we can connect your GitHub username to your contact info!
PLEASE NOTE: it can take up to 3 weeks after the event for the UF team to reach out and set up payment. Please be patient and do not spam us with emails or messages about payment.