Skip to content

docs: update bug report md to assist reporters into providing more information #278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wmundev merged 2 commits into from
Dec 2, 2024
Merged

docs: update bug report md to assist reporters into providing more information #278

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16e17c8
docs: update bug report md to assist reporters into providing more in…
wmundev Dec 2, 2024
204b527
docs: update wording
wmundev Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 23 additions & 13 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,29 @@ assignees: ''

Thanks for contributing to libphonenumber-csharp!

Please read the following before filing an issue.
We appreciate your effort in helping us improve the library by submitting a bug report.

## Checklist before filing an issue

Please check the following:
* Is the issue reproducible using the
[Google demo](http://libphonenumber.appspot.com/)?

If yes:
Please read the following checklist before filing an issue.

* Please file an issue with [Google](https://github.com/google/libphonenumber)

If not:
## Checklist before filing an issue

* Your issue may be resolved by upgrading to the latest version of the
library. If the issue exists in the latest version please file an issue here.
- [ ] Is the issue reproducible using the [Google demo](http://libphonenumber.appspot.com)?
- If yes, please file an issue with [Google](https://github.com/google/libphonenumber)
- If not, proceed to the next steps.
- [ ] Is this issue related to the metadata for a specific region phone number?
- If yes, please file an issue with [Google](https://github.com/google/libphonenumber)
- We use all metadata information directly from Google's libphonenumber repository, see an example [here](https://github.com/twcclegg/libphonenumber-csharp/commit/eacacd3783a14880461adad9c38f614469fcca3c)
- See github action [here](https://github.com/twcclegg/libphonenumber-csharp/actions/workflows/create_new_release_on_new_metadata_update.yml) that will automatically update the metadata and publish a new nuget package.
- See examples of an issue that should be filed with [Google](https://github.com/google/libphonenumber) and not in this repository
- [here](https://github.com/twcclegg/libphonenumber-csharp/issues/259)
- [here](https://github.com/twcclegg/libphonenumber-csharp/issues/214)
- [here](https://github.com/twcclegg/libphonenumber-csharp/issues/272)
- If not, proceed to the next steps.
- [ ] Have you upgraded to the latest version of the library?
- If not, please upgrade to the latest version and check if the issue still exists.
- If yes, proceed to the next steps.
- [ ] Have you provided a clear and concise title for the issue?
- [ ] Have you included all relevant details and steps to reproduce the issue?
- [ ] Have you attached any necessary logs, screenshots, or code snippets?

Thank you for your contribution!