Skip to content

Commit 84419d5

Browse files
devmoathdevmoath
committed
👷 add issue template
1 parent f9ab0bf commit 84419d5

File tree

6 files changed

+118
-33
lines changed

6 files changed

+118
-33
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Bug Report
2+
description: Report an Issue or Bug with the Package
3+
title: ":bug: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
I'm sorry to hear you have a problem. Can you help me solve it by providing the following details.
10+
- type: textarea
11+
id: what-happened
12+
attributes:
13+
label: What happened?
14+
description: What did you expect to happen?
15+
placeholder: I cannot currently do X thing because when I do, it breaks X thing.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: how-to-reproduce
20+
attributes:
21+
label: How to reproduce the bug
22+
description: How did this occur, please add any config values used and provide a set of reliable steps if possible.
23+
placeholder: When I do X I see Y.
24+
validations:
25+
required: true
26+
- type: input
27+
id: package-version
28+
attributes:
29+
label: Package Version
30+
description: What version of our Package are you running? Please be as specific as possible
31+
placeholder: 1.0.0
32+
validations:
33+
required: true
34+
- type: input
35+
id: php-version
36+
attributes:
37+
label: PHP Version
38+
description: What version of PHP are you running? Please be as specific as possible
39+
placeholder: 8.2.0
40+
validations:
41+
required: true
42+
- type: dropdown
43+
id: operating-systems
44+
attributes:
45+
label: Which operating systems does with happen with?
46+
description: You may select more than one.
47+
multiple: true
48+
options:
49+
- macOS
50+
- Windows
51+
- Linux
52+
- type: textarea
53+
id: notes
54+
attributes:
55+
label: Notes
56+
description: Use this field to provide any other notes that you feel might be relevant to the issue.
57+
validations:
58+
required: false

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
ank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/devmoath/jql-builder/discussions/new?category=q-a
5+
about: Ask the community for help
6+
- name: Request a feature
7+
url: https://github.com/devmoath/jql-builder/discussions/new?category=ideas
8+
about: Share ideas for new features
9+
- name: Report a security issue
10+
url: https://github.com/devmoath/jql-builder#security-vulnerabilities
11+
about: Learn how to notify us for sensitive bugs

‎.github/dependabot.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
labels:
8+
- "dependencies"

‎.github/workflows/formats.yml

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
name: Formats
22

3-
on: [ 'push', 'pull_request' ]
3+
on: ["push", "pull_request"]
44

55
jobs:
66
formats:
77
runs-on: ${{ matrix.os }}
88
strategy:
99
fail-fast: true
1010
matrix:
11-
os: [ ubuntu-latest ]
12-
php: [ 8.2 ]
13-
stability: [ prefer-stable ]
11+
os: [ubuntu-latest]
12+
php: [8.2]
13+
stability: [prefer-stable]
1414

1515
name: Formats php@${{ matrix.php }} - ${{ matrix.os }} - ${{ matrix.stability }}
1616

1717
steps:
18-
- name: Checkout
19-
uses: actions/checkout@v3
18+
- name: Checkout
19+
uses: actions/checkout@v3
2020

21-
- name: Setup PHP
22-
uses: shivammathur/setup-php@v2
23-
with:
24-
php-version: ${{ matrix.php }}
25-
coverage: none
21+
- name: Setup PHP
22+
uses: shivammathur/setup-php@v2
23+
with:
24+
php-version: ${{ matrix.php }}
25+
coverage: none
2626

27-
- name: Install Composer dependencies
28-
run: composer update --${{ matrix.stability }} --no-interaction
27+
- name: Install Composer dependencies
28+
run: composer update --${{ matrix.stability }} --no-interaction
2929

30-
- name: Coding Style Checks
31-
run: composer test:lint
30+
- name: Coding Style Checks
31+
run: composer test:lint
3232

33-
- name: Type Checks
34-
run: composer test:types
33+
- name: Type Checks
34+
run: composer test:types

‎.github/workflows/tests.yml

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
name: Tests
22

3-
on: [ 'push', 'pull_request' ]
3+
on: ["push", "pull_request"]
44

55
jobs:
66
tests:
77
runs-on: ${{ matrix.os }}
88
strategy:
99
fail-fast: true
1010
matrix:
11-
os: [ ubuntu-latest ]
12-
php: [ '8.0', 8.1, 8.2 ]
13-
stability: [ prefer-lowest, prefer-stable ]
11+
os: [ubuntu-latest]
12+
php: ["8.0", 8.1, 8.2]
13+
stability: [prefer-lowest, prefer-stable]
1414

1515
name: Tests php@${{ matrix.php }} - ${{ matrix.os }} - ${{ matrix.stability }}
1616

1717
steps:
18-
- name: Checkout
19-
uses: actions/checkout@v3
18+
- name: Checkout
19+
uses: actions/checkout@v3
2020

21-
- name: Setup PHP
22-
uses: shivammathur/setup-php@v2
23-
with:
24-
php-version: ${{ matrix.php }}
25-
coverage: pcov
21+
- name: Setup PHP
22+
uses: shivammathur/setup-php@v2
23+
with:
24+
php-version: ${{ matrix.php }}
25+
coverage: pcov
2626

27-
- name: Install Composer dependencies
28-
run: composer update --${{ matrix.stability }} --no-interaction
27+
- name: Install Composer dependencies
28+
run: composer update --${{ matrix.stability }} --no-interaction
2929

30-
- name: Unit Tests
31-
run: composer test:unit
30+
- name: Unit Tests
31+
run: composer test:unit

‎README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,14 @@ echo $query;
9696
// 'summary = "value"'
9797
```
9898

99-
---
99+
## Contributing
100+
101+
Thank you for considering contributing to the JQL Builder! The contribution guide can be found in the [CONTRIBUTING](CONTRIBUTING.md).
102+
103+
## Security Vulnerabilities
104+
105+
If you discover any security-related issues, please email moath.alhajrii@gmail.com instead of using the issue tracker.
106+
107+
## License
100108

101109
JQL builder is an open-sourced software licensed under the **[MIT license](https://opensource.org/licenses/MIT)**.

0 commit comments

Comments
 (0)