Skip to content

Commit

Permalink
Update templates
Browse files Browse the repository at this point in the history
  • Loading branch information
TonyCTHsu committed Jul 16, 2024
1 parent a1461da commit e3eab22
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 30 deletions.
52 changes: 34 additions & 18 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,42 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] ..."
labels: ''
assignees: ''

about: Create a report for a defect
title: "..."
labels: 'category/bug'
---

**Describe the bug**
A clear and concise description of what the bug is.
### Description

<!-- Describe the problem clearly and concisely. -->

### Expected behavior

<!-- What did you expect to happen? -->

### Actual behavior

<!-- What happened instead? -->

### Steps to reproduce

1. <!-- ... -->
2. <!-- ... -->
3. <!-- ... -->

### Screenshots, logs, and other output

**To Reproduce**
Steps to reproduce the behavior:
1. ...
2. ...
3. ...
<!-- If applicable, add more material to help explain your problem. -->

**Expected behavior**
A clear and concise description of what you expected to happen.
<details>
<summary>Details</summary>
<pre><code>
<!-- Add logs here -->
</code></pre>
</details>

**Screenshots**
If applicable, add screenshots to help explain your problem.
### Additional context

**Additional context**
Add any other context about the problem here.
Environment:
- gem version:
- Ruby engine version:
- OS and/or container image:
22 changes: 10 additions & 12 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE] ..."
labels: ''
assignees: ''

title: "..."
labels: 'category/feature'
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
### Is your feature request related to a problem? Please describe
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
### Describe the solution you'd like
<!-- A clear and concise description of what you want to happen. -->

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
### Describe alternatives you've considered
<!-- A clear and concise description of any alternative solutions or features you've considered. -->

**Additional context**
Add any other context or screenshots about the feature request here.
### Additional context
<!-- Add any other context or screenshots about the feature request here. -->
2 changes: 2 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Always write a clear log message for your commits. One-line messages are fine fo
>
> A paragraph describing what changed and its impact."

If in doubt, follow [this](https://cbea.ms/git-commit/).

## Coding conventions

Start reading our code and you'll get the hang of it. To avoid bikeshedding, run `bundle exec rubocop` and everything be fine.
Expand Down

0 comments on commit e3eab22

Please sign in to comment.