Thanks for contributing to libphonenumber!
Please read the following before filing an issue or sending a pull request.
We hope these guidelines will enhance your experience as a contributor to our library and know that we appreciate the time you put into making it better.
Please check the following:
Please copy this template into your report and answer the questions to the best of your ability. For acceptable evidence, see below.
* Country: * Example number(s) and/or range(s): * Number type ("fixed-line", "mobile", "short code", etc.): * For short codes, cost and dialing restrictions: * Where or whom did you get the number(s) from: * Authoritative evidence (e.g. national numbering plan, operator announcement): * Link from demo (http://libphonenumber.appspot.com) showing error:
As of March 2018, we kindly request that you use Google's Issue Tracker to report issues with the library. Using Issue Tracker will enable to us to get back to you more efficiently as we align GitHub user issues with ones reported at Google. Note that we transitioned active GitHub issues to Issue Tracker, but anything inactive for over a year must be filed again. To check if your issue was transitioned, see this list of issues.
Alternatively, if you have a particular issue with a Google product handling phone numbers (e.g. signup), you may also use the Google Product Forums.
Ideally, change requests for ranges should be accompanied by authoritative evidence such as official government or public carrier documents.
If the evidence is publicly available online, please provide the link.
If the evidence is not publicly available online, make sure that you have the rights to share this with us, and confirm this by reading and signing the appropriate Contributor License Agreement (CLA). Then we can accept this on GitHub, or we can invite you to a private Google Group archive if you prefer not to share on GitHub.
See https://cla.developers.google.com/about to determine whether you need to sign a Corporate or Individual CLA.
By signing the CLA, you confirm that you have the rights to share the information with us, and that we may use, modify, reproduce, publicly display, and distribute the information in accordance with the library's open source license.
Since all metadata (XML and mapping files) is generated automatically from other sources, we cannot accept pull requests to edit these files directly. This includes validation, formatting, geocoding, operator or timezone metadata. However this does not mean you cannot raise issues for this data.
For changes specific to windows builds, see Filing a code issue and make sure you have found a reviewer and tester before sending the pull request. If the issue wasn’t reproducible and seems to be specific to your build/setup, please prefer creating a code bug or email the discussion group than creating a pull request.
We are happy to review and accept pull requests for the following:
This list is not exhaustive. To clarify whether we'd accept a pull request, and especially before spending significant time on one such as for a bug fix, we strongly encourage that you bring up the question on an issue.
To get your pull request merged, we need the following:
PhoneNumberUtil.java
must be ported to phonenumberutil.cc
and phonenumberutil.js
.If this is not possible, please file an issue instead.
When filing a code issue, include the specifics of your operating system and provide as much information as possible that helps us reproduce the problem.
Please be advised that metadata updates are prioritized over code changes, except for bug fixes. In addition, we work with a limited number of build systems and may not be able to support every setup.
In particular, we don't actively maintain windows builds but would be able to accept a PR provided someone else in the open-source community could test it out and would be able to help with the review. One way to look for such collaborators would be to email the discussion group. Also see the known Windows issues.