Skip to content

Commit

Permalink
Formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
frankharkins committed Aug 22, 2023
1 parent 3d08a70 commit 6992bc6
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions 0000-ecosystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,11 @@ status.

The main function of the Ecosystem is to store a database of Qiskit-based
projects. We will label each project according to it's purpose, importance, and
maintenance status.
maintenance status. Users can access this data through the
[qiskit.org/ecosystem](https://qiskit.org/ecosystem) web page.

> :information_source: **Note on tiers**
>
> In the past, we've tried to show the importance and maintenance status of
> projects by sorting them into "tiers". This has caused some confusion as it's
> not clear what the tiers mean from their names alone.
Expand All @@ -62,11 +64,6 @@ maintenance status.
> status of projects clear using "IBM maintained" / "Community maintained"
> labels, and we can highlight the most important projects with a "Main" label.
Users can access this data through the
[qiskit.org/ecosystem](https://qiskit.org/ecosystem) web page.

This function of the Ecosystem has the highest impact to all users, and
requires the least maintenance.

A secondary function of the Ecosystem is to help developers and consumers of
Qiskit anticipate the effect of upcoming changes. Currently, the Ecosystem runs
Expand All @@ -88,6 +85,7 @@ regular testing.
## Detailed Design

- **Database**

Each record is a TOML file in a GitHub repository. This record will contain
at least the following information:
- Name
Expand All @@ -107,19 +105,22 @@ regular testing.
before acceptance.

- **Web page**

The web page ([qiskit.org/ecosystem](https://qiskit.org/ecosystem)) is built
daily using the data in the JSON file from the Ecosystem GitHub repository.

We will make the test results more meaningful to end users by removing
unneeded information, and by better explaining what the results mean.

- **Developer dashboard**

We will host a separate web page using GitHub pages, displaying the test
results in a more meaningful way to Qiskit developers. This page will be
built regularly, and will simply display a table of each repository's most
recent test results.

- **Regular testing**

A GitHub action regularly clones each project and runs the unit tests three
times: Once with the project's default requirements, once after
force-installing the latest release of Qiskit, and once after
Expand Down

0 comments on commit 6992bc6

Please sign in to comment.