Skip to content

Commit

Permalink
Issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Propaganistas committed Jun 21, 2024
1 parent 44efd6e commit c7dcc20
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 7 deletions.
7 changes: 0 additions & 7 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/01-validation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Unexpected validation result
description: "For troubleshooting validation results that fail or succeed unexpectedly."
body:
- type: markdown
attributes:
value: "## Please read this first"
- type: markdown
attributes:
value: |
Lots of issues are most often caused by incorrect mappings between request data and validation rules.
Please review and debug your own code properly before raising an issue.
- type: markdown
attributes:
value: |
Still receiving an unexpected result? This package leverages `libphonenumber` to power its validation capabilities. If `libphonenumber` reports a number to be (in)valid, this package does so.
This means that **only discrepancies** between `libphonenumber` and `Laravel-Phone` are bug reports targeted at this repository.
In case you encounter such a discrepancy, please fill in the form below to provide us with appropriate details.
- type: input
attributes:
label: Laravel-Phone version
description: Provide the Laravel-Phone version that you're using.
placeholder: 5.3.0
validations:
required: true
- type: input
attributes:
label: Reproducible Laravel-Phone demo URL
description: Go to https://laravel-phone.herokuapp.com/ and reproduce your issue. Paste the URL in here.
validations:
required: true
- type: input
attributes:
label: Reproducible libphonenumber demo URL
description: Go to https://giggsey.com/libphonenumber/ and reproduce your issue. Take note of the "isValidNumber" and "isValidNumberForRegion" results. Paste the URL in here.
validations:
required: true
- type: textarea
attributes:
label: Additional remarks
description: Anything you would like to add?
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/02-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Bug report
description: "Report something else that's broken."
body:
- type: input
attributes:
label: Laravel-Phone version
description: Provide the Laravel-Phone version that you're using.
placeholder: 5.3.0
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Provide detailed steps to reproduce your issue. If necessary, please provide a GitHub repository to demonstrate your issue.
validations:
required: true
- type: textarea
attributes:
label: Observed vs Expected behavior
description: Explain sufficiently detailed what you're observing and what you would have expected instead.
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Feature request
url: https://github.com/Propaganistas/Laravel-Phone/blob/master/.github/macroable.md
about: 'The PhoneNumber class is macroable to support whatever you need. If you feel that something might be useful for others, please open a pull request.'
14 changes: 14 additions & 0 deletions .github/macroable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Feature requests

This package is considered 95% feature-complete.

If your envisioned feature would just be forwarding results from `libphonenumber` without any added value, please resort to creating a macro.
E.g. determining the carrier from a phone number, ...

```php
PhoneNumber::macro('your_special_method', function() {
// ...
});
```

Otherwise, feel free to open a Pull Request with a detailed explanation of why the suggested feature is worth adding to the package.

0 comments on commit c7dcc20

Please sign in to comment.