diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ebb9d4a4fc..046826c928 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,14 @@ No pushing to master! New featues must be submitted in a separate branch (one br Any required migration files **must** be included in the commit, or the pull-request will be rejected. If you change the underlying database schema, make sure you run `make migrate` and commit the migration files before submitting the PR. +## Update Translation Files + +Any PRs which update translatable strings (i.e. text strings that will appear in the web-front UI) must also update the translation (locale) files to include hooks for the translated strings. + +*This does not mean that all translations must be provided, but that the translation files must include locations for the translated strings to be written.* + +To perform this step, simply run `make_translate` from the top level directory before submitting the PR. + ## Testing Any new code should be covered by unit tests - a submitted PR may not be accepted if the code coverage is decreased. diff --git a/docs/translate.rst b/docs/translate.rst index 3c2ad0d5f4..ba62dc6780 100644 --- a/docs/translate.rst +++ b/docs/translate.rst @@ -11,6 +11,6 @@ InvenTree supports multi-language translation using the `Django Translation Fram Translation strings are located in the `InvenTree/locales/` directory, and translation files can be easily added here. -To set the default language, change the `langauge` setting in the `config.yaml` settings file. +To set the default language, change the `language` setting in the `config.yaml` settings file. To recompile the translation files (after adding new translation strings), run the command ``make translate`` from the root directory.