Requesting Translation Guidelines

Textual changes to our core website pages generally involve translation into at least 2 other languages. To make translating as easy as possible for colleagues, please follow these guidelines:

1. Make sure you have everything perfect and ready before you ask for a translation. Have colleagues check over your original wording before submitting a pull request. That way translators only have to help once.
2. Translation may involve many files, or many sentences / paragraphs across a file. Be explicit about exactly what you need translated, and ask for it in ticket comments. Don't make translators dig through the files to try to figure out what you need amended. Use the following format, providing enough context so that they do not need to do any wider reading:

Dear Team: can you please help translate the following phrases into Spanish and French?:

about.md

The review process is an integral component of a collaborative and productive effort for scholars to teach and learn from each other.

TO:

The review process is an integral component of a collaborative, productive, and sustainable effort for scholars to teach and learn from each other.

---

Please discuss explicitly with the translator if you would like to incorporate the translations, or if you want them to do it. Both parties should be clear and provide enough context to the other to enable efficient publication. This simple approach makes it less time consuming for translators to help us with pull requests.

To alert translators to your request, @ both the relevant Managing Editor and Team (e.g. @spapastamkou & @programminghistorian/french-team) in the relevant Issue or Pull Request.