Skip to content

Commit

Permalink
docs: make it more clear to use develop branch for PRs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sv443 committed Nov 19, 2024
1 parent 5c7571a commit 03aee07
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,23 @@ Before submitting a translation, please check on [this document](https://github.
> **Please make sure you always select the `develop` branch when translating, as the `main` branch is only used for releases.**
To submit a translation, please follow these steps:
1. Copy the contents of the default translation file [`assets/translations/en-US.json`](./assets/translations/en-US.json)
2. Replace the `en-US` part of the file name with the language code and locale code of the language you want to translate to
1. Select the `develop` branch to translate for the latest version of BetterYTM.
If you are setting up the project for local development, also make sure you have checked out the `develop` branch.
2. Copy the contents of the default translation file [`assets/translations/en-US.json`](./assets/translations/en-US.json)
3. Replace the `en-US` part of the file name with the language code and locale code of the language you want to translate to
You can find [a list of these BCP 47 codes here.](https://www.techonthenet.com/js/language_tags.php)
The final locale code should always be in the format `language-COUNTRY` (e.g. `en-US`, `en-GB`, ...)
3. Translate the strings inside the file, while making sure not to change the keys on the left side of the colon and to preserve the placeholders with the format %n (where n is any number starting at 1).
4. Translate the strings inside the file, while making sure not to change the keys on the left side of the colon and to preserve the placeholders with the format %n (where n is any number starting at 1).
If you don't want to finish it in one go, please remove the extra keys before submitting the file. They can always be added back by running the command `pnpm run tr-format -p -o=language-COUNTRY` (see [this section](#editing-an-existing-translation) for more info).
4. If you like, you may also create a translation for the [`README-summary.md`](./README-summary.md) file for display on the userscript distribution sites
5. If you like, you may also create a translation for the [`README-summary.md`](./README-summary.md) file for display on the userscript distribution sites
Please duplicate the file `README-summary.md` and call it `README-summary-xx-YY.md` and place it in the [`assets/translations/`](./assets/translations/) folder.
5. If you want to submit a pull request with the translated file:
6. If you want to submit a pull request with the translated file:
1. Duplicate the `en-US.json` file in the folder [`assets/translations/`](./assets/translations/) by keeping the format `languageCode_localeCode.json`
2. Edit it to your translated version and keep the left side of the colon unchanged
3. Create the mapping in `assets/locales.json` by copying the English one and editing it (please make sure it's alphabetically ordered)
4. Add your name to the respective `authors` property in [`assets/locales.json`](./assets/locales.json)
5. Test your changes by following [this section](#setting-up-the-project-for-local-development), then submit your pull request
6. Alternatively send it to me directly, [see my homepage](https://sv443.net/) for contact info
7. Alternatively send it to me directly, [see my homepage](https://sv443.net/) for contact info
Make sure you also add your language to the contents of [`assets/locales.json`](./assets/locales.json)

<br>
Expand All @@ -73,7 +75,8 @@ To edit an existing translation, please follow these steps:
7. Test for syntax errors and update translation progress with the command `pnpm run tr-progress`
8. Open the file [`assets/translations/README.md`](./assets/translations/README.md) to see if you're still missing any untranslated keys (you don't have to translate them all, but it would of course be nice)
9. I highly encourage you to test your changes to see if the wording fits into the respective context by following [this section](#setting-up-the-project-for-local-development)
10. Submit your pull request by [clicking here](https://github.com/Sv443/BetterYTM/compare/) and setting the `compare:` dropdown to your fork
10. Submit your pull request by [clicking here](https://github.com/Sv443/BetterYTM/compare/) and setting the `compare:` dropdown to your fork and the `base:` dropdown to `develop`
Make sure to describe your changes in the pull request and reference the issue you are fixing, if applicable
11. Check that the CI checks just above the comment box pass and then wait for the pull request to be reviewed and merged

<br><br><br>
Expand All @@ -85,9 +88,9 @@ To edit an existing translation, please follow these steps:
1. Have current versions of Node.js, npm and Git installed
2. Install pnpm by running `npm i -g pnpm`
3. Clone this repository
If you plan on contributing to the project, please [click here to fork it](https://github.com/Sv443/BetterYTM/fork) and clone your fork instead.
Make sure to clone or fork from the `develop` branch since the `main` branch is only used for releases!
If you plan on contributing to the project through Git, please [click here to fork it](https://github.com/Sv443/BetterYTM/fork) and clone your fork instead.
4. Switch to the `develop` branch by running `git checkout -b develop` in the project root.
**I will only accept pull requests that were created from and to the `develop` branch**, since there is usually a newer version in progress on that branch compared to `main`
Skip this step if you are using your own forked repository.
5. Open a terminal in the project root and run `pnpm i`
6. Copy the file `.env.template` to `.env` and modify the variables inside to your needs.
Expand Down

0 comments on commit 03aee07

Please sign in to comment.