Skip to content

Commit

Permalink
Update submission form (#746)
Browse files Browse the repository at this point in the history
### Summary

Updates the submission form with some of the feedback from design. We
can't currently update the links as the new ones don't exist, and the
"group" / "labels" attributes will need to stay until the current page
is removed. Otherwise, all comments are addressed.

---------

Co-authored-by: Eric Arellano <[email protected]>
  • Loading branch information
frankharkins and Eric-Arellano authored Jul 11, 2024
1 parent 1d4889f commit c51e361
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 10 deletions.
19 changes: 9 additions & 10 deletions .github/ISSUE_TEMPLATE/submission.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ body:
description: >
Title of your project as it will appear on
[qiskit.github.io/ecosystem](https://qiskit.github.io/ecosystem).
placeholder: Qiskit GPU Compile
placeholder: E.g. Qiskit GPU Compile
validations:
required: true
- type: input
id: url
attributes:
label: Github repo
description: Link to GitHub repo of project you want to submit
placeholder: https://github.com/owner/qiskit-gpu-compile
placeholder: E.g. https://github.com/owner/qiskit-gpu-compile
validations:
required: true
- type: textarea
Expand All @@ -45,8 +45,7 @@ body:
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.
Keep it under 135 characters; anything longer will be rejected.
Note this **does not** support markdown.
placeholder: >
Expand All @@ -58,15 +57,15 @@ body:
id: contact_info
attributes:
label: Email
placeholder: [email protected]
placeholder: E.g. [email protected]
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Short description of alternative projects.
placeholder: There are no alternatives to this project!
placeholder: E.g. There are no alternatives to this project!
validations:
required: false
- type: dropdown
Expand All @@ -91,7 +90,7 @@ body:
attributes:
label: Affiliations
description: List any organisations affiliated with the project.
placeholder: None
placeholder: E.g. None
validations:
required: false
- type: checkboxes
Expand Down Expand Up @@ -152,22 +151,22 @@ body:
attributes:
label: Documentation
description: Link to project's documentation website
placeholder: https://your-project.com/documentation
placeholder: E.g. https://your-project.com/documentation
validations:
required: false
- type: input
id: website
attributes:
label: Website
description: Link to project or company website if applicable
placeholder: https://your-project.com
placeholder: E.g. 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
placeholder: E.g. https://arxiv.org/abs/2402.00022
validations:
required: false
12 changes: 12 additions & 0 deletions tests/utils/test_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

from ecosystem.models.repository import Repository
from ecosystem.utils import parse_submission_issue
from ecosystem.daos import DAO


class TestUtils(TestCase):
Expand Down Expand Up @@ -66,3 +67,14 @@ def test_issue_template_matches_repository_model(self):
repo_fields,
msg="\nA field exists in the issue template but not in the Repository class.",
)

def test_decription_lengths(self):
"""Make sure IDs in the issue template match attributes of the Repository model."""
# pylint: disable=no-self-use
dao = DAO("ecosystem/resources")
for repo in dao.get_all():
if len(repo.description) > 135:
raise AssertionError(
f'Description for "{repo.name}" is too long!\n'
f"Rephrase to under 135 characters (currently {len(repo.description)})"
)

0 comments on commit c51e361

Please sign in to comment.