8000 Fix bug report issue template (#8691) · activeadmin/activeadmin@742548d · GitHub
[go: up one dir, main page]
Skip to content

Commit 742548d

Browse files
taglialatagliala
authored
Fix bug report issue template (#8691)
This commit adjusts the bug report template to ensure it works as intended. While using a direct link like `issues/new?template=bug-report.md` can open the template in full-screen mode, this approach results in the template appearing twice in the issue creation list. Unfortunately, there is no available option in GitHub to hide the bug report template from the list while still allowing it to be accessible via a direct link. Given this limitation, the current configuration is the best achievable under these constraints. Close #8690
1 parent 265fde7 commit 742548d

File tree

2 files changed

+38
-3
lines changed

2 files changed

+38
-3
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: If you've already asked for help with a problem and confirmed something is broken with ActiveAdmin itself, create a bug report.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
<!-- Please provide all of the information requested below. We're a small team
10+
and without detailed information it's not possible for us to help and your bug
11+
report will be closed. -->
12+
13+
Describe your issue with a **clear title and description**. Make sure to include
14+
as much relevant information as possible, including a code sample or failing
15+
test that demonstrates the expected behavior, as well as your system
16+
configuration. Your goal should be to make it easy for yourself - and others -
17+
to reproduce the bug and figure out a fix.
18+
19+
### Expected behavior
20+
21+
What do you think should happen?
22+
23+
### Actual behavior
24+
25+
What actually happens?
26+
27+
### How to reproduce
28+
29+
Having a way to reproduce your issue will help people confirm, investigate,
30+
and ultimately fix your issue. You can do this by providing an executable test
31+
case. To make this process easier, please use [our bug report template script].
32+
33+
Copy the content of the appropriate template into an `.rb` file and make the
34+
necessary changes to demonstrate the issue. You can execute it by running
35+
`ruby the_file.rb` in your terminal. If all goes well, you should see your test
36+
case failing.
37+
38+
[our bug report template script]: https://github.com/activeadmin/activeadmin/blob/master/tasks/bug_report_template.rb

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ contact_links:
66
- name: Feature Request
77
url: https://github.com/activeadmin/activeadmin/discussions/new?category=ideas
88
about: Suggest any ideas you have using our discussion forums.
9-
- name: Bug Report
10-
url: https://github.com/activeadmin/activeadmin/issues/new?body=%3C%21--%20Please%20provide%20all%20of%20the%20information%20requested%20below.%20We%27re%20a%20small%20team%20and%20without%20detailed%20information%20it%27s%20not%20possible%20for%20us%20to%20help%20and%20your%20bug%20report%20will%20be%20closed.%20--%3E%0A%0ADescribe%20your%20issue%20with%20a%20%2A%2Aclear%20title%20and%20description%2A%2A.%20Make%20sure%20to%20include%20as%20much%20relevant%20information%20as%20possible%2C%20including%20a%20code%20sample%20or%20failing%20test%20that%20demonstrates%20the%20expected%20behavior%2C%20as%20well%20as%20your%20system%20configuration.%20Your%20goal%20should%20be%20to%20make%20it%20easy%20for%20yourself%20-%20and%20others%20-%20to%20reproduce%20the%20bug%20and%20figure%20out%20a%20fix.%0A%0A%23%23%23%20Expected%20behavior%0A%0AWhat%20do%20you%20think%20should%20happen%3F%0A%0A%23%23%23%20Actual%20behavior%0A%0AWhat%20actually%20happens%3F%0A%0A%23%23%23%20How%20to%20reproduce%0A%0AHaving%20a%20way%20to%20reproduce%20your%20issue%20will%20help%20people%20confirm%2C%20investigate%2C%20and%20ultimately%20fix%20your%20issue.%20You%20can%20do%20this%20by%20providing%20an%20executable%20test%20case.%20To%20make%20this%20process%20easier%2C%20please%20use%20%5Bour%20bug%20report%20template%20script%5D.%0A%0ACopy%20the%20content%20of%20the%20appropriate%20template%20into%20an%20%60.rb%60%20file%20and%20make%20the%20necessary%20changes%20to%20demonstrate%20the%20issue.%20You%20can%20execute%20it%20by%20running%20%60ruby%20the_file.rb%60%20in%20your%20terminal.%20If%20all%20goes%20well%2C%20you%20should%20see%20your%20test%20case%20failing.%0A%0A%5Bour%20bug%20report%20template%20script%5D%3A%20https%3A%2F%2Fgithub.com%2Factiveadmin%2Factiveadmin%2Fblob%2Fmaster%2Ftasks%2Fbug_report_template.rb
11-
about: If you've already asked for help with a problem and confirmed something is broken with ActiveAdmin itself, create a bug report.
129
- name: Documentation Issue
1310
url: https://github.com/activeadmin/activeadmin/pulls
1411
about: For documentation improvements, feel free to create a pull request.

0 commit comments

Comments
 (0)
0