Rewrite issue, pull request templates (fix #581)

Former-commit-id: 0d08229

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -2,10 +2,11 @@ name: Bug Report
 description: File a bug report
 title: '[BUG]: '
 labels: ['bug']
+
 body:
   - type: markdown
     attributes:
-      value: |
+      value: >
         Thanks for taking the time to fill out this bug report!
 
   - type: input
@@ -14,32 +15,39 @@ body:
       label: Contact Details [Optional]
       description: How can we get in touch with you if we need more info?
       placeholder: your-name@here.com
+
     validations:
       required: false
 
   - type: textarea
     id: system-information
+
     attributes:
       label: System Information
       description: '`python -m superduperdb info`'
-      placeholder: 'Copy then paste the output of the above command here.'
+      placeholder: Copy then paste the output of the above command here
+
     validations:
       required: true
 
   - type: textarea
     id: what-happened
+
     attributes:
       label: What happened?
       description: Also tell us, what did you expect to happen?
-      placeholder: A clear and concise description of what the bug is.
+      placeholder: A clear and concise description of what the bug is
+
     validations:
       required: true
 
   - type: textarea
     id: reproduce
     attributes:
       label: Steps to reproduce
-      description: 'How do you trigger this bug? Please walk us through it step by step.'
+      description: >
+        How do you trigger this bug? Please walk us through it step by step
+
       value: |
         1.
         2.
@@ -52,5 +60,8 @@ body:
     id: logs
     attributes:
       label: Relevant log output
-      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      description: |
+        Please copy and paste any relevant log output.
+        This will be automatically formatted into code, so no need for backticks
+
       render: shell

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,21 @@
+blank_issues_enabled: true
+
+contact_links:
+  - name: Discussions
+    url: https://github.com/SuperDuperDB/superduperdb/discussions
+    about: "Discuss superduperdb on GitHub"
+
+  - name: Show and Tell
+    url: https://github.com/SuperDuperDB/superduperdb/discussions/categories/show-and-tell
+    about: "Show the world what you've done with superduperdb"
+
+  - name: Chat with us
+    url: https://superduperdb.slack.com/
+    about: Ask a question, or simply say hello
+
+  - name: Documentation
+    url: https://superduperdb.github.io/superduperdb/
+
+  - name: Feedback
+    about: Ask a question, or simply say hello
+    url: https://docs.google.com/forms/d/e/1FAIpQLScKNyLCjSEWAwc-THjC7NJVDNRxQmVR5ey30VVayPhWOIhy1Q/viewform?vc=0&c=0&w=1&flr=0&usp=mail_form_link

.github/ISSUE_TEMPLATE/doc_improvement.yml

@@ -0,0 +1,15 @@
+body:
+- type: textarea
+  attributes:
+    label: What's wrong?
+    description: >
+      Tell us what's missing, wrong, or just plain confusing.
+
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: How could it be better?
+    description: >
+      How we could fix the documentation to solve this?

.github/pull_request_template.md

@@ -1,24 +1,37 @@
+<!--
+Thanks for contributing a pull request!
+
+If this is your first time, please have a look at the contribution guidelines here:
+
+https://github.com/superduperdb/superduperdb/blob/main/CONTRIBUTING.md
+-->
+
+
 ## Description
 
-<!-- Provide a brief description of the changes introduced by this pull request -->
-<!-- If adding a new feature, please describe the intended way of using this feature as clearly as possible -->
+<!-- A brief description of the changes in this pull request -->
 
-## Related Issue(s)
 
-<!-- If your pull request is related to any GitHub issue(s), mention them here with the appropriate links -->
+## Related Issues
 
-## Checklist
+<!-- Link to any related github issues here.
 
-<!-- Mark the tasks that are completed. You can add or remove items as necessary -->
+Examples:
+   Update serialization (fix #1234)
+   Move data to location (see #3456)
 
-- [ ] Change or addition is covered by unit and/or integration tests. If bugfix, there should be at least one test that fails pre-PR and passes after.
-- [ ] Classes and functions substantially affected by this PR have `sphinx` format docstrings added or updated.
-- [ ] If your changes introduce modifications to functionality, behavior, or usage of the project, please ensure that the documentation is updated accordingly.
-<!-- Update relevant sections such as README files and user guides to help users understand the changes and how to use the updated features. -->
+You might want to read
+https://github.com/blog/1506-closing-issues-via-pull-requests
+-->
 
-## Additional Notes
 
-<!-- Add any additional notes, comments, or explanations that may be helpful to the reviewers -->
+## Checklist
 
+- [ ] Is this code covered by new or existing unit tests or integration tests?
+- [ ] Did you run `make test` successfully?
+- [ ] Do new classes, functions, methods and parameters all have docstrings?
+- [ ] Were existing docstrings updated, if necessary?
+- [ ] Was external documentation updated, if necessary?
 
 
+## Additional Notes or Comments