Add note reminding to update

Qiskit · Apr 29, 2024 · 39e0b8e · 39e0b8e
1 parent 22cc6b1
commit 39e0b8e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/.github/ISSUE_TEMPLATE/submission.yml b/.github/ISSUE_TEMPLATE/submission.yml
@@ -5,6 +5,8 @@ labels: ["submission"]
 assignees:
   - octocat
 body:
+  # The IDs of each input must correspond with the attributes of the repository model
+  # in ecosystem/models/repository.py 
   - type: markdown
     attributes:
       value: |

diff --git a/ecosystem/models/repository.py b/ecosystem/models/repository.py
@@ -10,7 +10,11 @@
 
 @dataclass
 class Repository(JsonSerializable):
-    """Main repository class."""
+    """Main repository class.
+
+    NOTE: These attribute names must exist in the issue template.
+    See .github/ISSUE_TEMPLATE/submission.yml
+    """
 
     # pylint: disable=too-many-instance-attributes
     name: str | None = None