Learn essential best practices for open-sourcing quantum code and joining the Qiskit Ecosystem in this 22-minute instructional video. Master key aspects of creating high-quality open-source projects, including writing effective READMEs, choosing appropriate licenses, implementing unit tests, and establishing proper documentation. Explore practical demonstrations of Git operations, project setup, and community engagement strategies. Discover how to make quantum code more accessible through proper project descriptions, readable code standards, and comprehensive documentation. Follow step-by-step guidance on setting up project infrastructure, from managing requirements to implementing testing frameworks, and understand the specific requirements for becoming part of the Qiskit Ecosystem. Access valuable resources including project templates, markdown guides, and license selection tools to enhance your open-source quantum development journey.
Best Practices for Open Source Quantum Code and Joining the Qiskit Ecosystem
Overview
Syllabus
- Tips for improving your open-source project
- Make your project easy to use
- Add a project description
- Add a README
- Add a License
- Add milestones/releases
- Make the code readable
- Code comments
- Documentation
- Improve reliability
- Unit tests
- Engage with the community
- Setup issues, pull requests
- Branching strategy
- Add discussion tab
- Apply to join open-source project lists
- When in doubt, use a project template!
- Demo Time!
- What do you need to join the Qiskit Ecosystem?
- Git Fetch & Git Pull
- How to add a README.md
- How to add a requirements.txt
- How to add tests to your project
- Add, commit and push your changes
- Add a license
- How to submit an application to join the Qiskit Ecosystem
Taught by
Qiskit
