Skip to content

Commit 957596d

Browse files
daviddrysdaledaviddrysdale
committed
Populate .github/ with templates
A large fraction of Issues and Pull Requests are metadata changes that get rejected & redirected to the upstream project. Try to save everyone's time by making this clearer in templates.
1 parent 8c742f1 commit 957596d

3 files changed

Lines changed: 25 additions & 0 deletions

File tree

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

File renamed without changes.

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Issue reports are welcome, but note that the project is directly
2+
derived from the
3+
[upstream Java project](https://github.com/googlei18n/libphonenumber).
4+
5+
As a result, any changes to the phonenumber metadata or to the API should be
6+
[submitted there](https://github.com/googlei18n/libphonenumber/issues) rather
7+
than here; only issues or contributions that are specific to the Python version
8+
are likely to be relevant here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Please report changes to metadata to the upstream [libphonenumber](https://github.com/googlei18n/libphonenumber/)
2+
project rather than here.
3+
4+
In other words, please do not send pull requests with changes in files under any of the
5+
following directories:
6+
7+
- `python/phonenumbers/data/`
8+
- `python/phonenumbers/carrierdata/`
9+
- `python/phonenumbers/shortdata/`
10+
- `python/phonenumbers/geodata/`
11+
- `python/phonenumbers/tzdata/`
12+
13+
All of these directories hold code that is autogenerated from the metadata in the `resources/`
14+
directory, which is an exact copy of the
15+
[equivalent directory](https://github.com/googlei18n/libphonenumber/tree/master/resources)
16+
in the upstream project.
17+

0 commit comments

Comments
 (0)