Skip to content

Commit 4a3e0bf

Browse files
committed
Issue #11
1 parent e1c9b35 commit 4a3e0bf

File tree

3 files changed

+101
-0
lines changed

3 files changed

+101
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
## Bug Report
11+
12+
### Description
13+
14+
A clear and concise description of what is the overall operation that is intended to be
15+
performed that resulted in an error.
16+
17+
### Reproducibility
18+
Include:
19+
- OS (WIN | MACOS | Linux)
20+
- DataJoint Element Version
21+
- MySQL Version
22+
- MySQL Deployment Strategy (local-native | local-docker | remote)
23+
- Minimum number of steps to reliably reproduce the issue
24+
- Complete error stack as a result of evaluating the above steps
25+
26+
### Expected Behavior
27+
A clear and concise description of what you expected to happen.
28+
29+
### Screenshots
30+
If applicable, add screenshots to help explain your problem.
31+
32+
### Additional Research and Context
33+
Add any additional research or context that was conducted in creating this report.
34+
35+
For example:
36+
- Related GitHub issues and PR's either within this repository or in other relevant
37+
repositories.
38+
- Specific links to specific lines or a focus within source code.
39+
- Relevant summary of Maintainers development meetings, milestones, projects, etc.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: DataJoint Contribution Guideline
4+
url: https://docs.datajoint.org/python/community/02-Contribute.html
5+
about: Please make sure to review the DataJoint Contribution Guidelines
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for a new feature
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
## Feature Request
11+
12+
### Problem
13+
14+
A clear and concise description how this idea has manifested and the context. Elaborate
15+
on the need for this feature and/or what could be improved. Ex. I'm always frustrated
16+
when [...]
17+
18+
### Requirements
19+
20+
A clear and concise description of the requirements to satisfy the new feature. Detail
21+
what you expect from a successful implementation of the feature. Ex. When using this
22+
feature, it should [...]
23+
24+
### Justification
25+
26+
Provide the key benefits in making this a supported feature. Ex. Adding support for this
27+
feature would ensure [...]
28+
29+
### Alternative Considerations
30+
31+
Do you currently have a work-around for this? Provide any alternative solutions or
32+
features you've considered.
33+
34+
### Related Errors
35+
Add any errors as a direct result of not exposing this feature.
36+
37+
Please include steps to reproduce provided errors as follows:
38+
- OS (WIN | MACOS | Linux)
39+
- DataJoint Element Version
40+
- MySQL Version
41+
- MySQL Deployment Strategy (local-native | local-docker | remote)
42+
- Minimum number of steps to reliably reproduce the issue
43+
- Complete error stack as a result of evaluating the above steps
44+
45+
### Screenshots
46+
If applicable, add screenshots to help explain your feature.
47+
48+
### Additional Research and Context
49+
Add any additional research or context that was conducted in creating this feature request.
50+
51+
For example:
52+
- Related GitHub issues and PR's either within this repository or in other relevant
53+
repositories.
54+
- Specific links to specific lines or a focus within source code.
55+
- Relevant summary of Maintainers development meetings, milestones, projects, etc.
56+
- Any additional supplemental web references or links that would further justify this
57+
feature request.

0 commit comments

Comments
 (0)