Skip to content

Commit b60b490

Browse files
Adds templates.
1 parent 498cb12 commit b60b490

4 files changed

Lines changed: 196 additions & 0 deletions

File tree

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: Bug Report
2+
description: Report a bug in bead
3+
labels: ["bug", "triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to report a bug! Please fill out the form below.
9+
10+
**Note**: For questions or help, please use [GitHub Discussions](https://github.com/FACTSlab/bead/discussions) instead.
11+
12+
- type: checkboxes
13+
id: checks
14+
attributes:
15+
label: Checklist
16+
options:
17+
- label: I have searched the existing issues and this is not a duplicate
18+
required: true
19+
- label: I am using the latest version of bead
20+
required: true
21+
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Bug Description
26+
description: A clear and concise description of the bug.
27+
placeholder: What happened?
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: reproduction
33+
attributes:
34+
label: Steps to Reproduce
35+
description: Minimal code example that reproduces the issue.
36+
placeholder: |
37+
```python
38+
from bead import ...
39+
40+
# Code that reproduces the bug
41+
```
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: expected
47+
attributes:
48+
label: Expected Behavior
49+
description: What did you expect to happen?
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: actual
55+
attributes:
56+
label: Actual Behavior
57+
description: What actually happened? Include the full error traceback if applicable.
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: environment
63+
attributes:
64+
label: Environment
65+
description: Please provide your environment details.
66+
value: |
67+
- bead version:
68+
- Python version:
69+
- OS:
70+
- Installation method (uv/pip):
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: additional
76+
attributes:
77+
label: Additional Context
78+
description: Any other context, screenshots, or information about the problem.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions & Help
4+
url: https://github.com/FACTSlab/bead/discussions
5+
about: Please ask questions in GitHub Discussions instead of opening an issue.
6+
- name: Documentation
7+
url: https://bead.readthedocs.io
8+
about: Check the documentation for guides and API reference.
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
labels: ["enhancement", "triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for suggesting a feature! Please fill out the form below.
9+
10+
**Note**: For questions or discussion, please use [GitHub Discussions](https://github.com/FACTSlab/bead/discussions) first.
11+
12+
- type: checkboxes
13+
id: checks
14+
attributes:
15+
label: Checklist
16+
options:
17+
- label: I have searched the existing issues and this feature has not been requested
18+
required: true
19+
20+
- type: textarea
21+
id: problem
22+
attributes:
23+
label: Problem Statement
24+
description: What problem does this feature solve? Why is it needed?
25+
placeholder: I'm always frustrated when...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: solution
31+
attributes:
32+
label: Proposed Solution
33+
description: How do you envision this feature working?
34+
placeholder: |
35+
I would like to be able to...
36+
37+
```python
38+
# Example of how it might work
39+
```
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: alternatives
45+
attributes:
46+
label: Alternatives Considered
47+
description: Have you considered other approaches or workarounds?
48+
49+
- type: dropdown
50+
id: component
51+
attributes:
52+
label: Component
53+
description: Which part of bead does this relate to?
54+
options:
55+
- Resources (lexicons, templates)
56+
- Template filling
57+
- Items (construction, models)
58+
- Lists (partitioning, constraints)
59+
- Deployment (jsPsych, JATOS)
60+
- Active learning
61+
- Simulation
62+
- CLI
63+
- Documentation
64+
- Other
65+
66+
- type: textarea
67+
id: additional
68+
attributes:
69+
label: Additional Context
70+
description: Any other context, mockups, or examples.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Description
2+
3+
<!-- Describe your changes in detail. What does this PR do? -->
4+
5+
## Motivation
6+
7+
<!-- Why is this change needed? Link to related issues if applicable. -->
8+
9+
Fixes #
10+
11+
## Type of Change
12+
13+
<!-- Mark the relevant option with an "x" -->
14+
15+
- [ ] Bug fix (non-breaking change that fixes an issue)
16+
- [ ] New feature (non-breaking change that adds functionality)
17+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
18+
- [ ] Documentation update
19+
- [ ] Refactoring (no functional changes)
20+
- [ ] Tests (adding or updating tests)
21+
22+
## Checklist
23+
24+
<!-- Mark completed items with an "x" -->
25+
26+
- [ ] I have read the [CONTRIBUTING](../CONTRIBUTING.md) guidelines
27+
- [ ] My code follows the project's style guidelines
28+
- [ ] I have run `uv run ruff check .` and `uv run ruff format .`
29+
- [ ] I have run `uv run pyright` with no errors
30+
- [ ] I have added tests that prove my fix/feature works
31+
- [ ] All tests pass (`uv run pytest tests/`)
32+
- [ ] I have updated documentation as needed
33+
34+
## Testing
35+
36+
<!-- Describe how you tested your changes -->
37+
38+
## Screenshots (if applicable)
39+
40+
<!-- Add screenshots to help explain your changes -->

0 commit comments

Comments
 (0)