Skip to content

Commit 2250b13

Browse files
authored
chore: clean up issue templates (#1930)
<!-- ELLIPSIS_HIDDEN --> > [!IMPORTANT] > Cleaned up issue templates and replaced YAML-based pull request template with a Markdown version for better clarity and consistency. > > - **Issue Templates**: > - Renamed "BoundaryML" to "Boundary" in `01-bug_report.yml` and `02-feature_request.yml`. > - Changed label "To reproduce" to "Reproduction Steps" and "Version" to "BAML Version" in `01-bug_report.yml`. > - Removed unnecessary fields in `03-documentation.yml` and made some fields optional. > - **Pull Request Template**: > - Replaced YAML-based `pull_request_template.yml` with Markdown-based `pull_request_template.md`. > - The new template includes sections for issue reference, changes, testing, screenshots, checklist, and additional notes. > > <sup>This description was created by </sup>[<img alt="Ellipsis" src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=BoundaryML%2Fbaml&utm_source=github&utm_medium=referral)<sup> for 344f9df. You can [customize](https://app.ellipsis.dev/BoundaryML/settings/summaries) this summary. It will automatically update as commits are pushed.</sup> <!-- ELLIPSIS_HIDDEN -->
1 parent 649f030 commit 2250b13

File tree

5 files changed

+48
-90
lines changed

5 files changed

+48
-90
lines changed

.github/ISSUE_TEMPLATE/01-bug_report.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ body:
66
- type: dropdown
77
attributes:
88
label: Product
9-
description: Which BoundaryML product are you using?
9+
description: Which Boundary product are you using?
1010
options:
1111
- BAML
1212
- VS Code Playground
@@ -23,13 +23,13 @@ body:
2323
required: true
2424
- type: textarea
2525
attributes:
26-
label: To reproduce
26+
label: Reproduction Steps
2727
description: Describe how to reproduce your bug. Steps, code snippets, reproduction repos etc.
2828
validations:
2929
required: true
3030
- type: input
3131
attributes:
32-
label: Version (Optional)
32+
label: BAML Version (Optional)
3333
description: Which version of BAML are you using?
3434
- type: dropdown
3535
attributes:

.github/ISSUE_TEMPLATE/02-feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ body:
66
- type: dropdown
77
attributes:
88
label: Product
9-
description: Which BoundaryML product would this feature be for?
9+
description: Which Boundary product would this feature be for?
1010
options:
1111
- BAML
1212
- VS Code Playground

.github/ISSUE_TEMPLATE/03-documentation.yml

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,42 +3,24 @@ description: Request documentation improvements or report documentation issues
33
title: "[docs] "
44
labels: ["documentation"]
55
body:
6-
- type: textarea
7-
attributes:
8-
label: Documentation Issue
9-
description: What documentation needs to be improved or added?
10-
validations:
11-
required: true
12-
- type: textarea
13-
attributes:
14-
label: Current Documentation
15-
description: If applicable, what is the current documentation that needs improvement?
166
- type: textarea
177
attributes:
188
label: Proposed Changes
199
description: What changes would you like to see in the documentation?
2010
validations:
2111
required: true
22-
- type: dropdown
12+
- type: textarea
2313
attributes:
24-
label: Product
25-
description: Which BoundaryML product's documentation needs improvement?
26-
options:
27-
- BAML Language
28-
- VS Code Playground
29-
- Boundary Studio
30-
- Prompt Fiddle
31-
- Other
14+
label: Current Documentation (Optional)
15+
description: If applicable, what is the current documentation that needs improvement?
3216
- type: dropdown
3317
attributes:
34-
label: Documentation Type
18+
label: Documentation Type (Optional)
3519
description: What type of documentation is this?
3620
options:
3721
- Getting Started Guide
3822
- API Reference
3923
- Tutorial
4024
- Example
4125
- Best Practices
42-
- Other
43-
validations:
44-
required: true
26+
- Other
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Pull Request Template
2+
3+
Thanks for taking the time to fill out this pull request!
4+
5+
## Issue Reference
6+
Please link to any related issues
7+
- [ ] This PR fixes/closes #[issue number]
8+
9+
## Changes
10+
Please describe the changes proposed in this pull request
11+
12+
[Describe your changes here...]
13+
14+
## Testing
15+
Please describe how you tested these changes
16+
17+
- [ ] Unit tests added/updated
18+
- [ ] Manual testing performed
19+
- [ ] Tested in [environment]
20+
21+
## Screenshots
22+
If applicable, add screenshots to help explain your changes
23+
24+
[Add screenshots here...]
25+
26+
## PR Checklist
27+
Please ensure you've completed these items
28+
29+
- [ ] I have read and followed the contributing guidelines
30+
- [ ] My code follows the style guidelines of this project
31+
- [ ] I have performed a self-review of my own code
32+
- [ ] I have commented my code, particularly in hard-to-understand areas
33+
- [ ] I have made corresponding changes to the documentation
34+
- [ ] My changes generate no new warnings
35+
36+
## Additional Notes
37+
Add any other context about the PR here
38+
39+
[Add any additional notes here...]

.github/PULL_REQUEST_TEMPLATE/pull_request_template.yml

Lines changed: 0 additions & 63 deletions
This file was deleted.

0 commit comments

Comments
 (0)