Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BSD fixes #236: Initial github issue templates #296

Merged
merged 4 commits into from
Sep 18, 2024
Merged

BSD fixes #236: Initial github issue templates #296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f7060dc
Merge pull request #290 from Bixal/release/1.3.0
mattsqd Sep 4, 2024
11feb04
Merge pull request #292 from Bixal/release/1.3.1
mattsqd Sep 4, 2024
5aaaa83
BSD fixes #236: Initial github issue templates.
mejiaj Sep 6, 2024
8b47d16
BSD closes #236: Add label to feature request.
mejiaj Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: 'bixal-site-drupal - bug: '
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: BSD a better fit here? It's a standard convention for commits and branch names.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's an interesting question. I definitely think it's good to add bug in the issue title and in the labels (we should totally add a feature request label too for your below template) for visibility. But putting the site name in the title of every issue might take up a lot of real estate when both the submitter and the reviewer of the issue know where they are already. I would say BSD or not needed.

Copy link
Collaborator

@mattsqd mattsqd Sep 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should totally add a feature request label too for your below template

Ah, this already exists, it's enhancement

Copy link
Collaborator Author

@mejiaj mejiaj Sep 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mattsqd thanks for the feedback. Added the enhancement label in 8b47d16.

The site label might be useful as we're maintaining multiple GitHub projects. You can quickly distinguish which repo it's coming from. Shall I remove that for this initial version of the PR?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mattsqd thanks for the feedback. Added the enhancement label in 8b47d16.

The site label might be useful as we're maintaining multiple GitHub projects. You can quickly distinguish which repo it's coming from. Shall I remove that for this initial version of the PR?

I see, that makes sense. Feel free to leave as is and we can see how it works and go from there!

labels: bug
assignees: ''

---

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

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

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

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest an idea for this project
title: "bixal-site-drupal - feature request: "
labels: enhancement
assignees: ""
---

**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 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.