Skip to content

Commit 9cd2167

Browse files
authored
docs: update bug report md to assist reporters into providing more information (#278)
* docs: update bug report md to assist reporters into providing more information * docs: update wording
1 parent eacacd3 commit 9cd2167

File tree

1 file changed

+23
-13
lines changed

1 file changed

+23
-13
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+23-13
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,29 @@ assignees: ''
1111

1212
Thanks for contributing to libphonenumber-csharp!
1313

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

16-
## Checklist before filing an issue
17-
18-
Please check the following:
19-
* Is the issue reproducible using the
20-
[Google demo](http://libphonenumber.appspot.com/)?
21-
22-
If yes:
16+
Please read the following checklist before filing an issue.
2317

24-
* Please file an issue with [Google](https://github.com/google/libphonenumber)
25-
26-
If not:
18+
## Checklist before filing an issue
2719

28-
* Your issue may be resolved by upgrading to the latest version of the
29-
library. If the issue exists in the latest version please file an issue here.
20+
- [ ] Is the issue reproducible using the [Google demo](http://libphonenumber.appspot.com)?
21+
- If yes, please file an issue with [Google](https://github.com/google/libphonenumber)
22+
- If not, proceed to the next steps.
23+
- [ ] Is this issue related to the metadata for a specific region phone number?
24+
- If yes, please file an issue with [Google](https://github.com/google/libphonenumber)
25+
- We use all metadata information directly from Google's libphonenumber repository, see an example [here](https://github.com/twcclegg/libphonenumber-csharp/commit/eacacd3783a14880461adad9c38f614469fcca3c)
26+
- 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.
27+
- See examples of an issue that should be filed with [Google](https://github.com/google/libphonenumber) and not in this repository
28+
- [here](https://github.com/twcclegg/libphonenumber-csharp/issues/259)
29+
- [here](https://github.com/twcclegg/libphonenumber-csharp/issues/214)
30+
- [here](https://github.com/twcclegg/libphonenumber-csharp/issues/272)
31+
- If not, proceed to the next steps.
32+
- [ ] Have you upgraded to the latest version of the library?
33+
- If not, please upgrade to the latest version and check if the issue still exists.
34+
- If yes, proceed to the next steps.
35+
- [ ] Have you provided a clear and concise title for the issue?
36+
- [ ] Have you included all relevant details and steps to reproduce the issue?
37+
- [ ] Have you attached any necessary logs, screenshots, or code snippets?
38+
39+
Thank you for your contribution!

0 commit comments

Comments
 (0)