Add instructions for translating to contributing docs.

This commit is contained in:
Jeff Stieler 2019-07-09 10:12:34 -06:00
parent 489712a752
commit 8351c320af
3 changed files with 23 additions and 4 deletions

View File

@ -2,7 +2,7 @@
Hi! Thank you for your interest in contributing to WooCommerce Admin. We appreciate it. Hi! Thank you for your interest in contributing to WooCommerce Admin. We appreciate it.
There are many ways to contribute reporting bugs, feature suggestions, and fixing bugs. There are many ways to contribute reporting bugs, adding translations, feature suggestions, and fixing bugs.
## Reporting Bugs, Asking Questions, Sending Suggestions ## Reporting Bugs, Asking Questions, Sending Suggestions
@ -10,6 +10,21 @@ Open [a GitHub issue](https://github.com/woocommerce/woocommerce-admin/issues/ne
If you're filing a bug, specific steps to reproduce are always helpful. Please include what you expected to see and what happened instead. If you're filing a bug, specific steps to reproduce are always helpful. Please include what you expected to see and what happened instead.
## Localizing WooCommerce Admin
To translate WooCommerce Admin in your locale or language, [select your locale here](https://translate.wordpress.org/projects/wp-plugins/woocommerce-admin) and translate *Development* (which contains the plugin's string) and/or *Development Readme* (please translate what you see in the Details tab of the [plugin page](https://wordpress.org/plugins/woocommerce-admin/)).
A Global Translation Editor (GTE) or Project Translation Editor (PTE) with suitable rights will process your translations in due time.
Language packs are automatically generated once 95% of the plugin's strings are translated and approved for a locale.
### Testing translations in development without language packs
1. Export the translations strings as a `.po` file from the [translate.wordpress.org project](https://translate.wordpress.org/projects/wp-plugins/woocommerce-admin).
1. Rename `.po` file to the following format: `woocommerce-admin-xx_YY.po` (Where xx_YY is your locale, like it_IT)
1. Use WP-CLI to generate needed JSON files for JavaScript-based strings: `wp i18n make-json [.po file here] --no-purge`
1. Move `.po` and `.json` files to `/wp-content/languages/plugins`.
## We're Here To Help ## We're Here To Help
We encourage you to ask for help. We want your first experience with WooCommerce Admin to be a good one, so don't be shy. If you're wondering why something is the way it is, or how a decision was made, you can tag issues with [Type] Question or prefix them with “Question:” We encourage you to ask for help. We want your first experience with WooCommerce Admin to be a good one, so don't be shy. If you're wondering why something is the way it is, or how a decision was made, you can tag issues with [Type] Question or prefix them with “Question:”

View File

@ -39,4 +39,4 @@ If you have enabled WooCommerce usage tracking ( option `woocommerce_allow_track
## Contributing ## Contributing
There are many ways to contribute reporting bugs, feature suggestions and fixing bugs. For full details, please see [CONTRIBUTING.md](./CONTRIBUTING.md) There are many ways to contribute reporting bugs, adding translations, feature suggestions and fixing bugs. For full details, please see [CONTRIBUTING.md](./CONTRIBUTING.md)

View File

@ -1,5 +1,9 @@
Languages # Languages
=========
## Contributing a Translation
If you'd like to contribute a translation, please follow the Localizing section in [CONTRIBUTING.md](https://github.com/woocommerce/woocommerce-admin/blob/master/CONTRIBUTING.md).
## Generating POT
The generated POT template file is not included in this repository. To create this file locally, follow instructions from [README.md](https://github.com/woocommerce/woocommerce-admin/blob/master/README.md) to install the project, then run the following command: The generated POT template file is not included in this repository. To create this file locally, follow instructions from [README.md](https://github.com/woocommerce/woocommerce-admin/blob/master/README.md) to install the project, then run the following command: