diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..170bb9f4 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,25 @@ + + +**Summary**: + +**Related issue**: + +**Checklist**: + +* [ ] The header of all files contain a reference to the repository license +* [ ] The overall test coverage is increased or remains the same as before +* [ ] All tests are passing +* [ ] All flake8 checks are passing and the style guide is followed +* [ ] Documentation (as docstrings) is complete and understandable +* [ ] Only files that have been actively changed are committed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 288d2b15..386caefd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,6 +25,9 @@ either `testing` or `dev` branch. * If your contribution is a fix for the latest testing release, branch from the `testing` branch. * If your contribution is a new feature, branch from the `dev` branch. +Please do not make your changes on a branch with the same name as any of the above mentioned +branches. You should make a unique and descriptive branch name in your fork for your changes. + ## Pull Request Process 1. Make sure your code passes all tests and conforms to the style guide. You can check that the diff --git a/i18n/README.md b/i18n/README.md index 8f460445..9d206a5f 100644 --- a/i18n/README.md +++ b/i18n/README.md @@ -6,6 +6,12 @@ folder at the root of the repository, and the `nw_XX.qm` together with the `proj are located in `nw/assets/i18n`. The latter are JSON files translation maps for the novelWriter projects, used by the Build Novel Project tool. +**Note** + +When making a new translation, or updating an existing one, only commit the `nw_XX.ts` you have +made changes to. The `qtlupdate` command mentioned below will likely modify all `nw_XX.ts` +slightly, but please _don't_ commit those changes and add them to the pull request. + ## Qt GUI Localisation The `.qm` files are the actual files used by the application to translate the GUI into another