Improve submitter experience (#669)

### Summary This PR improves the experience for people submitting projects. - Updates the README and issue templates (which were quite out-of-date) - Adds a basic acceptance criteria (closes #600) --------- Co-authored-by: Eric Arellano <[email protected]>
Qiskit · Feb 6, 2024 · 1a87438 · 1a87438
1 parent 20e9a85
commit 1a87438
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 47 deletions.
diff --git a/.github/ISSUE_TEMPLATE/submission.yml b/.github/ISSUE_TEMPLATE/submission.yml
@@ -5,42 +5,45 @@ labels: ["submission"]
 assignees:
   - octocat
 body:
-  - type: markdown
-    attributes:
-      value: |
-        Provide information about your project.
   - type: input
     id: name
     attributes:
       label: Project name
-      description: Title of your project as it will appear on [qiskit.github.io/ecosystem](https://qiskit.github.io/ecosystem).
-      placeholder: Qiskit IBM Runtime
+      description: >
+        Title of your project as it will appear on
+        [qiskit.github.io/ecosystem](https://qiskit.github.io/ecosystem).
+      placeholder: Qiskit GPU Compile
     validations:
       required: true
   - type: input
     id: repo
     attributes:
       label: Github repo
       description: Link to GitHub repo of project you want to submit
-      placeholder: https://github.com/Qiskit/qiskit
+      placeholder: https://github.com/owner/qiskit-gpu-compile
     validations:
       required: true
   - type: textarea
     id: description
     attributes:
       label: Description
-      description: |
-        A couple of sentences to appear under your project on [qiskit.github.io/ecosystem](https://qiskit.github.io/ecosystem), try to keep it under 50 words.
+      description: >
+        1-2 sentences to appear under your project on
+        [qiskit.github.io/ecosystem](https://qiskit.github.io/ecosystem).
+        Keep it under 30 words; readers will click through to your repo if
+        they want to learn more.
+
         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.
+      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
-      placeholder: awesome_person@awesome_main.com
+      placeholder: [email protected]
     validations:
       required: false
   - type: textarea
@@ -80,7 +83,9 @@ body:
     id: group
     attributes:
       label: Group
-      description: Which group your project belongs to on [qiskit.github.io/ecosystem](https://qiskit.github.io/ecosystem).
+      description: >
+        Which group your project belongs to on
+        [qiskit.github.io/ecosystem](https://qiskit.github.io/ecosystem).
       multiple: false
       options:
         - transpiler_plugin
@@ -92,23 +97,27 @@ body:
   - type: dropdown
     id: labels
     attributes:
-      description: |
-        Labels are how users discover your project on [qiskit.github.io/ecosystem](https://qiskit.github.io/ecosystem).
-        If you don't think any existing labels apply to your project, leave a comment after submitting your issue requesting a new label.
+      description: >
+        Labels are how users discover your project on
+        [qiskit.github.io/ecosystem](https://qiskit.github.io/ecosystem). If
+        you don't think any existing labels apply to your project, leave a
+        comment after submitting your issue requesting a new label.
       label: Labels
       multiple: true
       options:
         - Advocate mentorship project
         - Algorithms
         - Chemistry
-        - Circuit simulator
         - Circuit
+        - Circuit simulator
         - Converter
         - Error correction
         - Error mitigation
+        - Education
         - Finance
         - Game
         - Hardware
+        - IBM maintained
         - Julia
         - Jupyter notebook
         - Machine learning
@@ -121,14 +130,31 @@ body:
         - Prototype
         - Provider
         - Quantum information
+        - Rust
         - Software development kit
         - Transpiler plugin
         - Visualization
+  - type: input
+    id: documentation
+    attributes:
+      label: Documentation
+      description: Link to project's documentation website
+      placeholder: https://your-project.com/documentation
+    validations:
+      required: false
   - type: input
     id: website
     attributes:
       label: Website
-      description: Link to project's website
+      description: Link to project or company website if applicable
       placeholder: https://your-project.com
     validations:
       required: false
+  - type: input
+    id: reference_paper
+    attributes:
+      label: Reference paper
+      description: If your project is based on a paper, you can link it here.
+      placeholder: https://arxiv.org/abs/2402.00022
+    validations:
+      required: false
diff --git a/README.md b/README.md
@@ -14,49 +14,41 @@
   <h3 align="center">Ecosystem</h3>
 </p>
 
-## About the Ecosystem
+## About the ecosystem
 
-The Qiskit Ecosystem is a collection of software and tutorials that builds on
+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).
-
-This repository manages members of the ecosystem, and can run regular tests on
-each project to alert maintainers of upcoming breaking changes.
+at [qiskit.github.io/ecosystem/](https://qiskit.github.io/ecosystem/).
 
+This repository handles submissions to the ecosystem and builds the web page.
 
 ## How to join
 
-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.
+Simply fill in the [submission issue
+form](https://github.com/qiskit-community/ecosystem/issues/new?assignees=octocat&labels=&projects=&template=submission.yml&title=%5BSubmission%5D%3A+).
+This will automatically create a pull request adding your project to this
+repository. We'll review the pull request and get back to you within a few
+days.
 
-3. **Open a project submission issue**
-
-   Once you're ready, [open 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.
+To join the ecosystem, your project must:
+  - Have an open-source license
+  - Adhere to our [code of conduct](./CODE_OF_CONDUCT.md)
+  - Build on, interface with, or extend Qiskit in some way
 
 Once your submission has been approved and merged, it will appear on
-[qiskit.org/ecosystem](https://qiskit.org/ecosystem) within 24hrs.
+[qiskit.github.io/ecosystem/](https://qiskit.github.io/ecosystem/) within a few
+minutes.
 
-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.
+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 blog; reach out to [Frank
+Harkins]([email protected]) 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)
+To change your project's information, edit 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 [open 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.