Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve applicant experience #465

Merged
merged 16 commits into from
Jul 31, 2023
Merged
18 changes: 11 additions & 7 deletions .github/ISSUE_TEMPLATE/submission.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,25 @@ body:
id: repo
attributes:
label: Github repo
description: Link to your github repo with project you want to submit
description: Link to GitHub repo of project you want to submit
placeholder: https://github.com/Qiskit/qiskit-terra
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: Short description of the project.
placeholder: Tell us about your work!
value: "..."
description: |
A couple of sentences to appear under your project on [qiskit.org/ecosystem](https://qiskit.org/ecosystem), try to keep it under 50 words.
Note this **does not** support markdown.
placeholder: |
E.g. Use your GPU to compile huge quantum circuits in seconds. Supports all modern devices and operating systems.
validations:
required: true
- type: input
id: contacts
attributes:
label: Email
description: Your contact information
placeholder: awesome_person@awesome_main.com
validations:
required: false
Expand Down Expand Up @@ -63,13 +64,16 @@ body:
id: affiliations
attributes:
label: Affiliations
description: Affiliations of the project.
description: List any organisations affiliated with the project.
placeholder: None
validations:
required: false
- type: dropdown
id: tags
attributes:
description: |
Tags are how users discover your project on [qiskit.org/ecosystem](https://qiskit.org/ecosystem).
If you don't think any existing tags apply to your project, leave a comment after submitting your issue requesting a new tag.
label: Tags
multiple: true
options:
Expand All @@ -94,7 +98,7 @@ body:
id: website
attributes:
label: Website
description: Link to project website
description: Link to project's website
placeholder: https://your-project.com
validations:
required: false
52 changes: 41 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,53 @@
<h3 align="center">Ecosystem</h3>
</p>

## Contents
1. [About The Project](#about-the-project)
2. [Join the Ecosystem](#join-the-ecosystem)
3. [Members](#members)
4. [Contribution Guidelines](#contribution-guidelines)
## About the Ecosystem

The Qiskit Ecosystem is a collection of software and tutorials that builds on
or extends Qiskit. The goal of the Ecosystem is to celebrate, support, and
accelerate development of quantum technologies using Qiskit. View all projects
at [qiskit.org/ecosystem](https://qiskit.org/ecosystem).

## About The Project
This repository manages members of the ecosystem, and can run regular tests on
each project to alert maintainers of upcoming breaking changes.

The Ecosystem consists of projects, tools, utilities, libraries and tutorials from a broad community of developers and researchers.
The goal of the Ecosystem is to recognize, support and accelerate development of quantum technologies using Qiskit.

[Read more about this project](./docs/project_overview.md).
## How to join

## [Join the Ecosystem](https://github.com/qiskit-community/ecosystem/issues/new?labels=&template=submission.yml&title=%5BSubmission%5D%3A+)
1. **Upload your project to GitHub**

2. **Add tests (optional)**

If you use [tox](https://tox.wiki/en/4.6.4/) tests to check your code, we
can run your tests regularly to detect breaking changes in current and
upcoming versions of Qiskit.

3. **Open a project submission issue**

Once you're ready, [make an
issue](https://github.com/qiskit-community/ecosystem/issues/new?assignees=octocat&labels=&projects=&template=submission.yml&title=%5BSubmission%5D%3A+)
asking to add your project to the Ecosystem. This will automatically create
a pull request adding your project to the repo. We'll review the pull request
and get back to you within a few days.

frankharkins marked this conversation as resolved.
Show resolved Hide resolved
Once your submission has been approved and merged, it will appear on
[qiskit.org/ecosystem](https://qiskit.org/ecosystem) within 24hrs.

Members of the ecosystem are invited to give a presentation about
their project at [Qiskit demo
day](https://github.com/Qiskit/feedback/wiki/Qiskit-DemoDays). You
can also write a post for the [Qiskit Medium
blog](https://medium.com/qiskit); reach out to a maintainer if
you're interested.

## How to update project information

To change your project's information, find your project's file in
[`.ecosystem/resources/members`](https://github.com/qiskit-community/ecosystem/tree/main/ecosystem/resources/members)
and make a pull request with the updated information. You can also [make an
issue](https://github.com/qiskit-community/ecosystem/issues/new?assignees=octocat&labels=update+request&projects=&template=update.yml&title=%5BProject+update%5D%3A+)
asking us to do it, or asking us to remove your project from the Ecosystem.

To join the Ecosystem create a [submission issue](https://github.com/qiskit-community/ecosystem/issues/new?labels=&template=submission.yml&title=%5BSubmission%5D%3A+)

## Contribution Guidelines

Expand Down
10 changes: 10 additions & 0 deletions ecosystem/resources/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Ecosystem database
==================

This folder contains the actual ecosystem data, including the data that appears
on [qiskit.org/ecosystem](https://qiskit.org/ecosystem).

If you want to edit or remove something, go to the [`members`](./members)
folder and edit or delete the TOML file for that repo. On pushing to `main`, a
GitHub action should recompile the JSON files that
[qiskit.org/ecosystem](https://qiskit.org/ecosystem) reads from.