Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create PR template #35

Merged
merged 2 commits into from
Feb 19, 2025
Merged

Create PR template #35

merged 2 commits into from
Feb 19, 2025

Conversation

MokaStitcher
Copy link
Contributor

This adds a PR template to the repo to help remind devs of the steps required when adding, updating or removing keys and of the merging process in each case. The merging process reminders get added to the PR description itself (in dropdowns) so that anyone looking at merging/approving the PR can consult them if needed as well.

Feel free to suggest modifications/additions.

Here is how a PR created with the template would look like after it's been posted:
(I have added all the <!-- comments --> in code blocks so that you can read them from here)

What are the changes introduced by this PR

<!-- Tell what this PR does and why -->
<!-- Specify which keys are being created, added or removed, if any -->

Checklist

<!-- This section can be ignored if the PR only adds translations to existing key(s) or fixes typo(s) -->

  • Have I created an associated PR in the main repo?
    • Please link it here:
  • Have I made sure that the changes work in game?
    • Have I provided screenshots of it in this PR or the main repo PR?

Does this PR add new key(s) to localize?

  • If so, have I made sure to add the new key(s) in the English file(s) only?
    <!-- not relevant for now - [ ] Has the translation/proofreading team been contacted about the new key(s)? -->
Merging process reminder for this situation
  • If the PR also updates or removes key(s), please refer below to the process for these cases instead
  • If not, this locale PR can be merged at any time as long as it has been approved
  • The main PR can then update the submodule by running the command git submodule update --remote --recursive --force and committing the change

Does this PR update or remove existing key(s) in English?

  • If so, have I deleted the outdated key(s) in all languages other than English?
    <!-- not relevant for now - [ ] Has the translation/proofreading team been contacted about the updated key(s)? -->
Merging process reminder for this situation
  • This locale PR should not be merged until the main repo PR is ready to be merged itself
  • Once both the main repo PR and this PR have the needeed approvals:
    • Merge this locale PR
    • In the main PR, update the submodule by running the command git submodule update --remote --recursive --force and committing the change
    • The main repo PR can now be merged

@MokaStitcher MokaStitcher added the enhancement New feature or request label Feb 18, 2025
@frutescens frutescens merged commit 3303ae0 into main Feb 19, 2025
1 check passed
@frutescens frutescens deleted the dev/pr-template branch February 19, 2025 01:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants