Submit a Project

Share your open source project on Polystacks. Your code stays on GitHub — we index and showcase it, linking back to your repository.

How it works

Add Polystacks metadata to your README

Include a YAML metadata block in your repository's README.md. This helps us categorize your project correctly.

Add the “polystacks” topic

On your GitHub repository, add polystacks as a repository topic.

Submit for review

Open a GitHub issue to notify us. We'll review and index your project within 48 hours.

Metadata template

Add this YAML block to the top of your README.md:

---
polystacks:
  framework: qiskit  # Options: qiskit, cirq, pennylane, qsharp, braket, pytket
  task-type: optimization  # Options: optimization, ml, chemistry, cryptography, algorithms, simulation
  hardware:
    - ibm-quantum
    - simulator
  qubits: 4  # Number of qubits required
  license: MIT
  verified: false  # Set to true if you're an official organization
---

Framework options

qiskitcirqpennylaneqsharpbraketpytket

Task types

optimizationmlchemistrycryptographyalgorithmssimulation

Complete README example

# Your Project Name

[![Polystacks](https://img.shields.io/badge/polystacks-listed-blue)](https://polystacks.dev)

## Description

A brief description of what your project does and why it's useful.

## Polystacks Metadata

```yaml
---
polystacks:
  framework: qiskit  # Options: qiskit, cirq, pennylane, qsharp, braket, pytket
  task-type: optimization  # Options: optimization, ml, chemistry, cryptography, algorithms, simulation
  hardware:
    - ibm-quantum
    - simulator
  qubits: 4  # Number of qubits required
  license: MIT
  verified: false  # Set to true if you're an official organization
---
```

## Installation

```bash
pip install qiskit
```

## Usage

```python
from qiskit import QuantumCircuit

# Your code here
circuit = QuantumCircuit(2)
circuit.h(0)
circuit.cx(0, 1)
```

## Citation

If you use this in your research, please cite:

```bibtex
@article{yourpaper2024,
  title={Your Paper Title},
  author={Your Name},
  year={2024}
}
```

## License

MIT License

Submit your project

Once you've added the metadata and topic, open a GitHub issue to notify us:

Submit via GitHub Issue

We review submissions within 48 hours.

Requirements

Required

Open source repository on GitHub
Valid Polystacks metadata in README
Working implementation
Open source license (MIT, Apache 2.0, GPL, etc.)
Basic documentation (installation, usage)

FAQ

Do I need to host my code on Polystacks?

No. Your code stays on GitHub. We index and showcase it, linking back to your repository.

Will my project auto-update?

Yes. Once indexed, we sync your README and metadata daily. Stars, forks, and other metrics update automatically.

Can I submit educational projects?

Absolutely. We welcome tutorials, learning resources, and educational implementations.

Can I remove my project later?

Yes. Remove the polystacks topic from your GitHub repository and it will be delisted within 24 hours.

Is there a cost?

No, it's free. Polystacks is a community platform.

Questions? Open an issue or reach out on the contact page.