Skip to content

Commit

Permalink
👷 add issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
devmoath committed Aug 21, 2023
1 parent f9ab0bf commit 84419d5
Show file tree
Hide file tree
Showing 6 changed files with 118 additions and 33 deletions.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Bug Report
description: Report an Issue or Bug with the Package
title: ":bug: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
I'm sorry to hear you have a problem. Can you help me solve it by providing the following details.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: What did you expect to happen?
placeholder: I cannot currently do X thing because when I do, it breaks X thing.
validations:
required: true
- type: textarea
id: how-to-reproduce
attributes:
label: How to reproduce the bug
description: How did this occur, please add any config values used and provide a set of reliable steps if possible.
placeholder: When I do X I see Y.
validations:
required: true
- type: input
id: package-version
attributes:
label: Package Version
description: What version of our Package are you running? Please be as specific as possible
placeholder: 1.0.0
validations:
required: true
- type: input
id: php-version
attributes:
label: PHP Version
description: What version of PHP are you running? Please be as specific as possible
placeholder: 8.2.0
validations:
required: true
- type: dropdown
id: operating-systems
attributes:
label: Which operating systems does with happen with?
description: You may select more than one.
multiple: true
options:
- macOS
- Windows
- Linux
- type: textarea
id: notes
attributes:
label: Notes
description: Use this field to provide any other notes that you feel might be relevant to the issue.
validations:
required: false
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
ank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/devmoath/jql-builder/discussions/new?category=q-a
about: Ask the community for help
- name: Request a feature
url: https://github.com/devmoath/jql-builder/discussions/new?category=ideas
about: Share ideas for new features
- name: Report a security issue
url: https://github.com/devmoath/jql-builder#security-vulnerabilities
about: Learn how to notify us for sensitive bugs
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
labels:
- "dependencies"
34 changes: 17 additions & 17 deletions .github/workflows/formats.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
name: Formats

on: [ 'push', 'pull_request' ]
on: ["push", "pull_request"]

jobs:
formats:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: true
matrix:
os: [ ubuntu-latest ]
php: [ 8.2 ]
stability: [ prefer-stable ]
os: [ubuntu-latest]
php: [8.2]
stability: [prefer-stable]

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

steps:
- name: Checkout
uses: actions/checkout@v3
- name: Checkout
uses: actions/checkout@v3

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
coverage: none
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
coverage: none

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

- name: Coding Style Checks
run: composer test:lint
- name: Coding Style Checks
run: composer test:lint

- name: Type Checks
run: composer test:types
- name: Type Checks
run: composer test:types
30 changes: 15 additions & 15 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
name: Tests

on: [ 'push', 'pull_request' ]
on: ["push", "pull_request"]

jobs:
tests:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: true
matrix:
os: [ ubuntu-latest ]
php: [ '8.0', 8.1, 8.2 ]
stability: [ prefer-lowest, prefer-stable ]
os: [ubuntu-latest]
php: ["8.0", 8.1, 8.2]
stability: [prefer-lowest, prefer-stable]

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

steps:
- name: Checkout
uses: actions/checkout@v3
- name: Checkout
uses: actions/checkout@v3

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
coverage: pcov
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
coverage: pcov

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

- name: Unit Tests
run: composer test:unit
- name: Unit Tests
run: composer test:unit
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,14 @@ echo $query;
// 'summary = "value"'
```

---
## Contributing

Thank you for considering contributing to the JQL Builder! The contribution guide can be found in the [CONTRIBUTING](CONTRIBUTING.md).

## Security Vulnerabilities

If you discover any security-related issues, please email moath.alhajrii@gmail.com instead of using the issue tracker.

## License

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

0 comments on commit 84419d5

Please sign in to comment.