Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<div align="center">
<h1>✨Contributors Guide — Quantum Gate Simulator & GUI Visualizer✨</h1>
<h3>
Welcome to the Quantum Gate Simulator & GUI Visualizer! 😍<br>
Thanks for your interest in contributing. 😊<br>
This guide will help you set up the project, run it locally, and make your first contribution.
</h3>
</div>


![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif)


<h2><b>Ways to Contribute</b>b></h2>

🐛 Report bugs: Use the issue template; include steps to reproduce, expected/actual behavior, OS/toolchain versions.

💡 Request features: Describe the use case and (if relevant) any UI/UX ideas for the GUI.

🧹 Improve docs: Clarify setup, add examples, or write tutorials.

🧪 Add tests: Unit tests for gates/state evolution; e2e checks for the GUI.

⚙️ Implement enhancements: Performance improvements, better numerics, new gates, or multi‑qubit support.

Before large changes, please open a design discussion issue first.

![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif)

<h2><b>How to Contribute:</b></h2>

⭐ Star this repository to show support.

🧭 Check open Issues. If something interests you, comment to express intent.

📝 Open an issue first (or use an existing one) describing what you plan to change. Wait to be assigned before writing code.

🔀 Fork the repo and create a focused branch: [repo link](https://github.com/Dark-CodeX/qubitverse.git)

🧪 Add tests and update docs alongside your change.

🧹 Format & lint: run the provided scripts (C++: clang-format/tidy; GUI: prettier/eslint) and make sure all tests pass.

🖼 If your PR affects the GUI, attach screenshots/GIFs. If it affects the simulator, include a short correctness note and, if relevant, a quick before/after performance snippet.

🔗 Use Conventional Commits and link the issue in your PR description (e.g., Closes #123).

📬 Open a Pull Request. The community will review and suggest improvements.

⏳ Limits: please keep ≤ 3 active issues assigned per person and 1 PR per issue. Avoid opening PRs for issues you’re not assigned to.


![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif)

<h2><b>Helpful Resources (Git & GitHub):</b></h2>

If you’re new to open source or GitHub, these official guides will get you moving quickly:

📌 [Creating an Issue (or PR) with GitHub Desktop](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request)

🍴 [Fork a Repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo)

⬇️ [Clone Your Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)

🔁 [Create a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)

🚀 [Getting Started with Git & GitHub](https://docs.github.com/get-started)


![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif)


<h2 align="center">Tip from us 😇</h1>
<p align="center">Every expert started at |0⟩ — apply one gate at a time and watch your skills evolve. You've got this! 💪</p>
<h3 align="center">Show some &nbsp;❤️&nbsp; by &nbsp;🌟&nbsp; this repository!</h3>