Browse Source

CONTRIBUTING.md reorg (#2040)

Reordering of sections since many folks seem to skip the metadata / issue filing guidelines
pull/2043/head
水に 8 years ago
committed by GitHub
parent
commit
ff5991337d
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 38 deletions
  1. +38
    -38
      CONTRIBUTING.md

+ 38
- 38
CONTRIBUTING.md View File

@ -7,44 +7,6 @@ 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 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. library and know that we appreciate the time you put into making it better.
## Pull requests
We do not accept pull requests for validation, formatting, or timezone metadata
updates.
For changes specific to windows builds, see [Filing a code
issue](#filing-a-code-issue) and make sure you have found a reviewer and tester
before sending the pull request.
We are happy to review and accept pull requests for the following:
* Carrier updates
* Geocoding updates
* Bug fixes
* Documentation and code hygiene cleanups
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:
* A CLA signature. See below.
* Responsiveness to back and forth review comments, because we will do a code
review.
* A link to a clear description of what the pull request intends to solve in a
[GitHub issue](https://github.com/googlei18n/libphonenumber/issues/new) or
Google's [Issue
Tracker](http://issuetracker.google.com/issues/new?component=192347).
* Tests that illustrate the issue, if applicable.
* Willingness and ability to implement the changes in C++, Java, and JS if
applicable. For example, changes to `PhoneNumberUtil.java` must be ported to
`phonenumberutil.cc` and `phonenumberutil.js`.
* The initial pull request may contain the implementation in only one
language to get approval on the approach.
If this is not possible, please file an issue instead.
## Checklist before filing an issue ## Checklist before filing an issue
Please check the following: Please check the following:
@ -131,6 +93,44 @@ license](http://github.com/googlei18n/libphonenumber/blob/master/LICENSE).**
mailing list. Only the core libphonenumber team has access to view mailing list. Only the core libphonenumber team has access to view
emails sent to this address. emails sent to this address.
## Pull requests
We do not accept pull requests for validation, formatting, or timezone metadata
updates.
For changes specific to windows builds, see [Filing a code
issue](#filing-a-code-issue) and make sure you have found a reviewer and tester
before sending the pull request.
We are happy to review and accept pull requests for the following:
* Carrier updates
* Geocoding updates
* Bug fixes
* Documentation and code hygiene cleanups
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:
* A CLA signature. See below.
* Responsiveness to back and forth review comments, because we will do a code
review.
* A link to a clear description of what the pull request intends to solve in a
[GitHub issue](https://github.com/googlei18n/libphonenumber/issues/new) or
Google's [Issue
Tracker](http://issuetracker.google.com/issues/new?component=192347).
* Tests that illustrate the issue, if applicable.
* Willingness and ability to implement the changes in C++, Java, and JS if
applicable. For example, changes to `PhoneNumberUtil.java` must be ported to
`phonenumberutil.cc` and `phonenumberutil.js`.
* The initial pull request may contain the implementation in only one
language to get approval on the approach.
If this is not possible, please file an issue instead.
## Filing a code issue ## Filing a code issue
When filing a code issue, include the specifics of your operating system and When filing a code issue, include the specifics of your operating system and


Loading…
Cancel
Save