Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

29 lines (21 loc) · 1.54 KB

Contributing code

Sorry, the 2.4 branch is still not quite ready for code contributions yet! Stay tuned.

Bug fixes and updates for the built-in story formats are being accepted for the 2.3 branch. Please open a PR against the 2.3-maintenance branch.

Contributing localizations

Twine's localization strings are stored in i18next JSON format. There are a number of dedicated editors for this format, or you can just use a plain text editor.

To add a new localization or edit an existing one:

  1. Clone the application source code using Git.
  2. Create a new branch for your work.
  3. Create or edit the appropriate file in public/locales. The file should be named after the language code you are localizing for. (Check the registry to find the appropriate code).
  4. If you are creating a new localization, copy the existing en-US.json file and replace the English strings there with localized ones in the new file.
  5. Commit your changes and create a pull request in GitHub. You should target the develop branch with your pull request.

Once your PR has been accepted, please join the Twine internationalization listserv by sending an email to twine-i18n-join@iftechfoundation.org. This is a low-traffic listserv that will be used to notify people who have worked on localization on Twine when future versions require localization work, e.g. when new text is added to the application.