Skip to content

Commit

Permalink
First commit
Browse files Browse the repository at this point in the history
  • Loading branch information
blythed committed Aug 22, 2024
0 parents commit 0a11fef
Show file tree
Hide file tree
Showing 433 changed files with 27,843 additions and 0 deletions.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Bug Report
description: File a bug report
title: '[BUG]: '
labels: ['bug']

body:
- type: markdown
attributes:
value: >
Thanks for taking the time to fill out this bug report!
- type: input
id: contact
attributes:
label: Contact Details [Optional]
description: How can we get in touch with you if we need more info?
placeholder: [email protected]

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

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

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
value: |
1.
2.
3.
...
validations:
required: false

- type: textarea
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
render: shell
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
blank_issues_enabled: true

contact_links:
- name: GitHub Discussions
url: https://github.com/SuperDuperDB/superduperdb/discussions
about: Ask questions and discuss SuperDuperDB on GitHub
- name: Chat with us on Slack
url: https://superduperdb.slack.com/
about: Ask a question, or simply say hello
- name: Documentation
about: See the documentation
url: https://superduperdb.github.io/superduperdb/
- 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 and get showcased!
- name: Consulting
url: mailto:[email protected]
about: Get free help from the maintainers to integrate SuperDuperDB into your AI project
- name: Feedback
about: Help us improve SuperDuperDB with your feedback!
url: https://docs.google.com/forms/d/e/1FAIpQLScKNyLCjSEWAwc-THjC7NJVDNRxQmVR5ey30VVayPhWOIhy1Q/viewform?vc=0&c=0&w=1&flr=0&usp=mail_form_link
- name: Join us!
about: We are looking for nice people who are invested in the problem we are trying to solve to join us full-time.
url: https://join.com/companies/superduperdb
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_improvement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Documentation improvement
description: Help us improve the documentation
title: '[DOC]: '
labels: ['doc']

body:
- type: textarea
attributes:
label: What's wrong?
description: |
Tell us what's missing, wrong, or just plain confusing.
You can also make changes and open a pull request!
validations:
required: true

- type: textarea
attributes:
label: How could it be better?
description: >
How we could fix the documentation to solve this?
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Feature request
description: Request a feature for addition to the roadmap
title: '[FEATURE REQUEST]: '
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
Thanks for your interest in SuperDuperDB. We take all feature requests seriously and will endeavour to respond in a timely manner!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: [email protected]
validations:
required: true

- type: textarea
id: feature
attributes:
label: Feature Description
description: Please describe the feature in detail?
placeholder: Description here.
validations:
required: true

- type: textarea
id: use-case
attributes:
label: Use Case Description
description: Please describe the real world issue which the implemented feature will solve
placeholder: 'Description here.'
validations:
required: true

- type: textarea
id: org
attributes:
label: Organization
description: Please describe the context this would be used in, e.g. your company, app, experimentation?
placeholder: Description here.
validations:
required: true

- type: textarea
id: stakeholders
attributes:
label: Who are the stake-holders?
description: Who are the major stake-holders in your use-case, who would be affected by the feature?
placeholder: Description here.
validations:
required: false
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/story.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Story
description: File a story. A story is a concise description of a product improvement. Ideally stories address specific concerns related to user experience.
labels: ["story"]
body:
- type: textarea
attributes:
label: Why
description: The rationale behind a desired change. Any supportive product-related documentation should be referenced here.
validations:
required: true
- type: textarea
attributes:
label: How
description: A short description of how assignees might approach implementing the change. Any technical documentation such as proposals should be references here.
- type: textarea
attributes:
label: What
description: A set of issues leading to accomplishing the story. These issues may span across multiple repositories. The set should be grouped into a task list using the markdown format. Essentially this is an implementation action plan.
value: |
- [ ]
Binary file added .github/logos/SuperDuperDB.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 0a11fef

Please sign in to comment.