Skip to content

Commit

Permalink
Merge pull request #6816 from ChurchCRM/bug-report-template-improvement
Browse files Browse the repository at this point in the history
improve bug report template
  • Loading branch information
DAcodedBEAT authored Jan 12, 2024
2 parents 02f97b2 + e872904 commit 2cf4f56
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 18 deletions.
52 changes: 35 additions & 17 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,52 @@ assignees: ''

**Description**

<!-- A clear and concise description of what the bug is. -->
A clear and concise description of what the reported bug is:

- ChurchCRM version:
- PHP version is the server running:
- DB Server and Version are you running:
- ChurchCRM version: [e.g. 5.4.3]
- PHP version the server running: [e.g. PHP 8.2.13]
- DB Server and Version the server is running: [e.g. MariaDB 11.4, MySQL 8.2]

**Steps To Reproduce**

<!-- Steps to reproduce the behavior: -->
Steps to reproduce the behavior:

1. Go to '...'
ℹ️ As a bug reporter, the preferred mechanism to record steps is to download Cypress Recorder from https://chromewebstore.google.com/detail/cypress-recorder/glcapdcacdfkokcmicllhcjigeodacab?pli=1, record your interaction and copy the results here.

📋 Cypress Recorder Results:
```
<please replace this section with the results from Cypress Recorder>
```

⚠️ If you cannot do this for some reason, please document the steps to reproduce below.

_(note: this flow is not recommend and will make it more difficult on the maintainers of ChurchCRM)_

1. Go to '...' (if possible, please provide the URL path e.g. `/v2/dashboard`)
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**

<!-- A clear and concise description of what you expected to happen. -->
A clear and concise description of what you expected to happen.

**Screenshots and/or logs**

<!-- If applicable, add screenshots or share logs help explain your problem. -->
If applicable, please include screenshots or share logs to assist in explaining your issue.

📋 Relevant screenshots:

> `<please insert your screenshots here>`
📋 Logs:
```
<please replace this section with the relevant logs>
```

**Debugging Steps**

<!-- If you need help debugging, please refer to the wiki for guidance: https://github.com/ChurchCRM/CRM/wiki/Logging-and-Diagnostics. -->
ℹ️ If you need help debugging, please refer to the wiki for guidance: https://github.com/ChurchCRM/CRM/wiki/Logging-and-Diagnostics.

* What has been done to debug the issue so far?
* Have you looked at the browser's developer tools to see if an error is thrown / network request failed?
Expand All @@ -43,17 +63,15 @@ assignees: ''

**Desktop (please complete the following information):**

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
- OS and Version: [e.g. Windows 11, macOS Sonoma 14.0]
- Browser (and Version): [e.g. Chrome 120.0.6099.216, Safari]

**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]
- Device: [e.g. iPhone15 Pro Max]
- OS: [e.g. iOS 17.2.1]
- Browser (and Version): [e.g. stock browser, Safari]

**Additional context**

<!-- Add any other context about the problem here. -->
Add any other context about the problem here.
6 changes: 5 additions & 1 deletion .github/workflows/build-test-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@ on:
pull_request:
branches:
- master
paths-ignore:
- '**/*.md'
push:
branches:
- master
paths-ignore:
- '**/*.md'

jobs:
test-n-package:
Expand Down Expand Up @@ -81,4 +85,4 @@ jobs:
uses: actions/upload-artifact@v3
with:
name: ChurchCRM-${{ steps.package-version.outputs.current-version}}-files
path: target/ChurchCRM-*.*
path: target/ChurchCRM-*.*

0 comments on commit 2cf4f56

Please sign in to comment.