hard-code examples

Author: paulmueller

.github/ISSUE_TEMPLATE/new-software-list-entry.md

@@ -12,15 +12,20 @@ Please fill in the following template. Use ``null`` if an entry does not apply.
 ```json
 {
   "Authors": "John Doe",
+  "Cite": "https://dx.doi.org/10.3.4",
   "Coding Language": "Python",
-  "Description": "An example description of the software",
+  "Description": "An example AFM software",
   "Documentation": "https://readthedocs.io/example",
   "Download Page": "https://example.com/downloads",
   "Homepage": null,
   "License": "GPL",
-  "Name": "AFM-example-software-name",
-  "Operating System": ["Windows", "macOS"],
+  "Name": "AFMsoft",
+  "Operating System": [
+    "Linux",
+    "macOS",
+    "Windows"
+  ],
   "Pricing Model": null,
-  "Repository": "https://github.com/example",
+  "Repository": "https://github.com/example"
 }
 ```

afm-list-manager.py

@@ -269,7 +269,7 @@ def generate_issue_template():
         data = json.load(fd)
     template = {}
     for item in data:
-        template[item["name"]] = None
+        template[item["name"]] = item["example"]
     dumped = json.dumps(template, **json_kwargs)
     [lines.append(dd) for dd in dumped.split("\n")]
     lines.append("```")

entry_keywords.json

@@ -1,50 +1,62 @@
 [
   {
-    "name":"Name",
-    "type":"str"
+    "name": "Name",
+    "type": "str",
+    "example": "AFMsoft"
   },
   {
-    "name":"Description",
-    "type":"str"
+    "name": "Description",
+    "type": "str",
+    "example": "An example AFM software description"
   },
   {
-    "name":"Authors",
-    "type":"str"
+    "name": "Authors",
+    "type": "str",
+    "example": "John Doe"
   },
   {
-    "name":"Repository",
-    "type":"url"
+    "name": "Repository",
+    "type": "url",
+    "example": "https://github.com/example"
   },
   {
-    "name":"Homepage",
-    "type":"url"
+    "name": "Homepage",
+    "type": "url",
+    "example": null
   },
   {
-    "name":"Documentation",
-    "type":"url"
+    "name": "Documentation",
+    "type": "url",
+    "example": "https://readthedocs.io/example"
   },
   {
-    "name":"Download Page",
-    "type":"url"
+    "name": "Download Page",
+    "type": "url",
+    "example": "https://example.com/downloads"
   },
   {
-    "name":"Coding Language",
-    "type":"str"
+    "name": "Coding Language",
+    "type": "str",
+    "example": "Python"
   },
   {
-    "name":"License",
-    "type":"str"
+    "name": "License",
+    "type": "str",
+    "example": "GPL"
   },
   {
-    "name":"Operating System",
-    "type":"list"
+    "name": "Operating System",
+    "type": "list",
+    "example": ["Linux", "macOS", "Windows"]
   },
   {
-    "name":"Pricing Model",
-    "type":"str"
+    "name": "Pricing Model",
+    "type": "str",
+    "example": null
   },
   {
-    "name":"Cite",
-    "type":"url"
+    "name": "Cite",
+    "type": "url",
+    "example": "https://dx.doi.org/10.3.4"
   }
 ]