Skip to content

Instantly share code, notes, and snippets.

@kdmukai

kdmukai/README.md

Last active September 23, 2025 03:29
Show Gist options
  • Save kdmukai/89071afb68a6a9018524c593141a0adb to your computer and use it in GitHub Desktop.
Save kdmukai/89071afb68a6a9018524c593141a0adb to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. kdmukai revised this gist May 1, 2025. 1 changed file with 71 additions and 0 deletions.
    71 changes: 71 additions & 0 deletions README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -63,6 +63,77 @@ On the following screen we will finalize your Pull Request (PR):

    ---

    ### Review new/updated screenshots
    Once your PR is created, you'll see the results of our automated checks:

    <img width="612" alt="Screenshot 2025-05-01 at 11 02 04 AM" src="https://gist.github.com/user-attachments/assets/1970d974-4241-4155-923f-ff637cc5f84f" />

    Click into "All checks have passed" to reveal the "CI / test (pull_request)" line. Click on that to view the details.

    <img width="853" alt="Screenshot 2025-05-01 at 11 05 01 AM" src="https://gist.github.com/user-attachments/assets/c87861ea-5f82-4439-adc7-9900c3943a9c" />

    Click "Summary" and scroll down to the "Artifacts" section:

    <img width="1025" alt="Screenshot 2025-05-01 at 11 07 28 AM" src="https://gist.github.com/user-attachments/assets/3bcb1b0e-dd7e-4944-a728-af8cacc91d6f" />

    Click the download arrow to download a zip file of the results.

    Inside you'll see:

    <img width="180" alt="Screenshot 2025-05-01 at 11 09 41 AM" src="https://gist.github.com/user-attachments/assets/918d0590-e87e-4fce-a62c-cd62cf6ce034" />

    Double click on the "index.html". This will open the "Screenshots Diff Report" in your browser. It will show a before/after of all screens that have been changed. It will also display new screens that were added and display any that were removed (adding or removing screens would only result from core codebase changes OR if you're adding a brand new language for the first time).

    It is up to you to review this diff report and visually inspect the impact your translation have had on the listed screens.

    We expect that many translations will need adjusting. The point of the Screenshot Diff Report is so that you can quickly identify problem translations and immediately return to Transifex to revise them.

    ---

    ### Which text can run offscreen and which cannot?

    Okay to run long:
    * Titles
    * Buttons

    ![ToolsDiceEntropyMnemonicLengthView](https://gist.github.com/user-attachments/assets/69fcadc6-5706-4877-9676-f70768c0f576)

    In this screenshot both the title and the active button will scroll the text back and forth into view. Better to avoid if possible, but totally acceptable if either require scrolling.

    NOT okay to run long:
    * Warning screen subheads
    * Any other body content

    ![SeedTranscribeSeedQRWarningView](https://gist.github.com/user-attachments/assets/7b06d4ac-580e-4a66-9161-acf1a3b6b5cb)

    Notice that the red subheader text does not fit. These subheads do NOT currently autoscroll.


    ![SeedExportXpubWarningView](https://gist.github.com/user-attachments/assets/1a2ee6e6-8a2b-4c4c-a5c1-74a528333ac1)

    Any text that runs too long vertically and ends up offscreen or obscured by another screen element would need to be rewritten to be shorter.



    ---

    ### Submitting revised translations to your existing PR
    If a screenshot does reveal a problematic translation, make your translation edits in Transifex, then repeat the process of downloading the translation file.

    Then at the top of your PR, click into your fork's branch:

    <img width="1016" alt="Screenshot 2025-05-01 at 11 21 33 AM" src="https://gist.github.com/user-attachments/assets/422fad5e-3837-4e1f-b1b7-6c36bc461b93" />

    Then follow the same steps from "Upload your changes to your fork" above to navigate to the proper folder and then "Upload files". Once again, select your `messages.po` file.

    The only difference this time through is that this will be treated as an additional commit on top of the one you did earlier. Once the updated file is committed, your PR will automatically include the latest changes.

    At this point the automated system will re-run itself and generate a new Screenshot Diff Report for you to download and review.

    Repeat this process as many times as necessary until you're satisified with all screens in the Screenshot Diff Report.

    ---

    ### What happens next?
    Now that your PR is created, the project maintainers will review your PR and either merge your changes into the main translations repo or request changes.

  2. kdmukai revised this gist Jan 13, 2025. 1 changed file with 31 additions and 56 deletions.
    87 changes: 31 additions & 56 deletions README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -16,79 +16,54 @@ Create an account on github.com if you haven't already.

    ---

    ### Prep the changes to the `seedsigner-translations` repo
    * Now go to our translations repo: https://github.com/SeedSigner/seedsigner-translations
    * Bit of magic here: CHANGE the url from "github.com" to "[github.dev](https://github.dev/SeedSigner/seedsigner-translations)".
    * That should load the repo in a fully interactive editor window right in your browser(!!!).
    * A directory browser will appear on the left.
    * Navigate into the `l10n` folder.
    * Navigate into your language code's `LC_MESSAGES` folder and find its `messages.po`:
    ### Fork the `seedsigner-translations` repo
    (skip this step if you've already forked it)

    <p align="center">
    <img width="435" src="https://gist.github.com/user-attachments/assets/7ddf41bd-8547-46b3-a998-3bf2430539bb" />
    </p>
    In order to submit a change, you'll need your own copy of the `seedsigner-translations` repo. Make sure you're signed in to your github account and then:
    * Go to the [translations repo](https://github.com/SeedSigner/seedsigner-translations)
    * Click "fork" at the top right.

    * Right-click on the `messages.po` file for your language and select "Delete permanently"
    * Don't worry, you don't have the repo permissions to do anything actually dangerous!
    * After it's deleted, right-click on your language's `LC_MESSAGES` folder and select "Upload".
    * Select the new `messages.po` file that you downloaded in the first step.
    * The file should appear yellow with a "M" next to it to indicate that it was "Modified":
    <img width="600" alt="Screenshot 2025-01-13 at 3 43 58 PM" src="https://gist.github.com/user-attachments/assets/b817df7e-2850-48cf-bc83-9354ac66c0d1" /><br/>

    <p align="center">
    <img width="435" src="https://gist.github.com/user-attachments/assets/a5c9532d-9f73-457c-ad33-774da1799db6" />
    </p>
    Leave all the defaults as they are and proceed with creating the fork.

    * Notice the blue circle with a "1" over the third icon. Click on that icon.
    * That will bring up the "SOURCE CONTROL" menu.
    ---

    <p align="center">
    <img width="565" src="https://gist.github.com/user-attachments/assets/a9e2d00a-af70-448f-b34e-559229339ad1" />
    </p>
    ### Upload your changes to your fork
    Your browser url should now be: github.com/<your_username>/seedsigner-translations

    * Click on `messages.po`. This will bring up a "diff" display, showing you what's changed in the file since the last update.
    * The previous version is on the left, the incoming changes are on the right.
    * It's a good practice to visually review the changes.
    * But if there are any errors, do NOT try to correct them here. All changes MUST happen in Transifex!
    * After making a change in Transifex, repeat these steps, starting with re-downloading the `messages.po` file from Transifex.
    * If everything looks good, click the "+" symbol next to the file. This adds it to the commit you're about to submit.
    * Write a brief description of the change:
    * Begin the description with "[ES update]" (or whichever language you're updating).
    * And then a very short explanation (e.g. "minor edits", "new Feature X screens", etc).
    * Now click "Commit & Push"
    * (I need someone to document these next steps more carefully for me)
    * If this is the first time you're creating a commit for this repo:
    * It will say that you don't have permission and will ask if you'd like to fork the repo.
    * Yes, fork the repo.
    * It will then suggest a name for a new branch for this commit (e.g. "patch-1").
    * Accept whatever name it suggests.
    Click into the `l10n/<language_code>/LC_MESSAGES` folder.

    ---
    `<language_code>` will be "es" for Spanish, "pt_BR" for Brazilian Portuguese, etc.

    ### Create a pull request (PR) for your commit
    You have now updated the translations in a branch in YOUR fork of the repo. Now we need to PR your changes back to the main `seedsigner-translations` repo.
    You should see a messages.mo and messages.po file. In the upper right click "Add file" and choose "Upload files":

    * Return to the main repo: https://github.com/SeedSigner/seedsigner-translations
    * You should see a notice about the changes you've made to your fork in a yellow box:
    <img width="600" alt="Screenshot 2025-01-13 at 3 51 22 PM" src="https://gist.github.com/user-attachments/assets/807a1b2d-8df8-4a3e-b671-49c72a903ede" /><br/>

    <p align="center">
    <img width="600" alt="Screenshot 2024-12-22 at 8 55 21 AM" src="https://gist.github.com/user-attachments/assets/0dff1332-aa49-405f-b908-9e1d9cdc0aa0" />
    </p>
    Verify that the following screen is listing the correct directory (you should be within the LC_MESSAGES folder for your language!):

    * Click "Compare & pull request".
    * You should now see the Pull Request page with your commit description auto-populated into the Title field.
    * If the Title field doesn't show what we typed in above, correct it now.
    <img width="800" alt="Screenshot 2025-01-13 at 3 54 38 PM" src="https://gist.github.com/user-attachments/assets/b3b34d90-6715-4e08-87aa-ac395f632f0c" />

    <p align="center">
    <img width="600" src="https://gist.github.com/user-attachments/assets/8cd8df16-f75b-4d37-a13d-baf8303dcb37" />
    </p>
    * Click to upload your `messages.po` file.
    * Select "Create a new branch for this commit and start a pull request."
    * Name your new branch with the language code and date: e.g. `es_2025-01-13`
    * Click "Propose changes".

    On the following screen we will finalize your Pull Request (PR):

    <img width="800" alt="Screenshot 2025-01-13 at 4 02 20 PM" src="https://gist.github.com/user-attachments/assets/f6c21233-53bf-495e-9695-1b38b2e51299" />

    * These changes are generally simple enough that you don't need to write anything in the Description field.
    * If you scroll down, you can review the diff at the bottom one last time.
    * Click on "compare across forks". That will alter the "base repository" droplist options.
    * Select "SeedSigner/seedsigner-translations" as the "base repository".
    * Its "dev" branch should already automatically be selected.
    * Add a title that includes the language code and (optional) additional context/info.
    * Scroll down and review the diff at the bottom.
    * If you spot any translations issues, you can only fix them back in Transifex. After any issues are fixed, you'll have to download the `messages.po` file and repeat this process.
    * Click "Create pull request" when you're ready.

    ---

    ### What happens next?
    Now that your PR is created, the project maintainers will review your PR and either merge your changes into the main translations repo or request changes.

    Merged changes will be included in the next SeedSigner release.
    Merged changes will then be included in the next SeedSigner release.
  3. kdmukai revised this gist Dec 22, 2024. 1 changed file with 8 additions and 1 deletion.
    9 changes: 8 additions & 1 deletion README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -84,4 +84,11 @@ You have now updated the translations in a branch in YOUR fork of the repo. Now

    * These changes are generally simple enough that you don't need to write anything in the Description field.
    * If you scroll down, you can review the diff at the bottom one last time.
    * Click "Create pull request" when you're ready.
    * Click "Create pull request" when you're ready.

    ---

    ### What happens next?
    Now that your PR is created, the project maintainers will review your PR and either merge your changes into the main translations repo or request changes.

    Merged changes will be included in the next SeedSigner release.
  4. kdmukai revised this gist Dec 22, 2024. 1 changed file with 2 additions and 1 deletion.
    3 changes: 2 additions & 1 deletion README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -75,7 +75,8 @@ You have now updated the translations in a branch in YOUR fork of the repo. Now
    </p>

    * Click "Compare & pull request".
    * You should now see the Pull Request page with your commit description auto-populated into the Title field:
    * You should now see the Pull Request page with your commit description auto-populated into the Title field.
    * If the Title field doesn't show what we typed in above, correct it now.

    <p align="center">
    <img width="600" src="https://gist.github.com/user-attachments/assets/8cd8df16-f75b-4d37-a13d-baf8303dcb37" />
  5. kdmukai revised this gist Dec 22, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -18,7 +18,7 @@ Create an account on github.com if you haven't already.

    ### Prep the changes to the `seedsigner-translations` repo
    * Now go to our translations repo: https://github.com/SeedSigner/seedsigner-translations
    * Bit of magic here: CHANGE the url from "github.com" to "github.dev".
    * Bit of magic here: CHANGE the url from "github.com" to "[github.dev](https://github.dev/SeedSigner/seedsigner-translations)".
    * That should load the repo in a fully interactive editor window right in your browser(!!!).
    * A directory browser will appear on the left.
    * Navigate into the `l10n` folder.
  6. kdmukai revised this gist Dec 22, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -16,7 +16,7 @@ Create an account on github.com if you haven't already.

    ---

    ### Modify your fork of the `seedsigner-translations` repo
    ### Prep the changes to the `seedsigner-translations` repo
    * Now go to our translations repo: https://github.com/SeedSigner/seedsigner-translations
    * Bit of magic here: CHANGE the url from "github.com" to "github.dev".
    * That should load the repo in a fully interactive editor window right in your browser(!!!).
  7. kdmukai revised this gist Dec 22, 2024. 1 changed file with 2 additions and 2 deletions.
    4 changes: 2 additions & 2 deletions README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -78,9 +78,9 @@ You have now updated the translations in a branch in YOUR fork of the repo. Now
    * You should now see the Pull Request page with your commit description auto-populated into the Title field:

    <p align="center">
    <img width="1141" alt="Screenshot 2024-12-22 at 9 05 41 AM" src="https://gist.github.com/user-attachments/assets/8cd8df16-f75b-4d37-a13d-baf8303dcb37" />
    <img width="600" src="https://gist.github.com/user-attachments/assets/8cd8df16-f75b-4d37-a13d-baf8303dcb37" />
    </p>

    * These changes are generally simple enough that you don't need to write anything in the Description field.
    * You can review the diff at the bottom one last time.
    * If you scroll down, you can review the diff at the bottom one last time.
    * Click "Create pull request" when you're ready.
  8. kdmukai revised this gist Dec 22, 2024. 1 changed file with 9 additions and 1 deletion.
    10 changes: 9 additions & 1 deletion README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -75,4 +75,12 @@ You have now updated the translations in a branch in YOUR fork of the repo. Now
    </p>

    * Click "Compare & pull request".
    *
    * You should now see the Pull Request page with your commit description auto-populated into the Title field:

    <p align="center">
    <img width="1141" alt="Screenshot 2024-12-22 at 9 05 41 AM" src="https://gist.github.com/user-attachments/assets/8cd8df16-f75b-4d37-a13d-baf8303dcb37" />
    </p>

    * These changes are generally simple enough that you don't need to write anything in the Description field.
    * You can review the diff at the bottom one last time.
    * Click "Create pull request" when you're ready.
  9. kdmukai created this gist Dec 22, 2024.
    78 changes: 78 additions & 0 deletions README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,78 @@
    # Submitting SeedSigner translation changes

    Create an account on github.com if you haven't already.

    ---

    ### Finish translation changes, download .po file
    * Update and review translations in Transifex.
    * Navigate to this screen in Transifex and click "Download for use":

    <p align="center">
    <img width="500" src="https://gist.github.com/user-attachments/assets/0a332a7e-2f75-4a44-a3bf-4c8126139588" />
    </p>

    * IMPORTANT: Rename the downloaded file to: `messages.po`

    ---

    ### Modify your fork of the `seedsigner-translations` repo
    * Now go to our translations repo: https://github.com/SeedSigner/seedsigner-translations
    * Bit of magic here: CHANGE the url from "github.com" to "github.dev".
    * That should load the repo in a fully interactive editor window right in your browser(!!!).
    * A directory browser will appear on the left.
    * Navigate into the `l10n` folder.
    * Navigate into your language code's `LC_MESSAGES` folder and find its `messages.po`:

    <p align="center">
    <img width="435" src="https://gist.github.com/user-attachments/assets/7ddf41bd-8547-46b3-a998-3bf2430539bb" />
    </p>

    * Right-click on the `messages.po` file for your language and select "Delete permanently"
    * Don't worry, you don't have the repo permissions to do anything actually dangerous!
    * After it's deleted, right-click on your language's `LC_MESSAGES` folder and select "Upload".
    * Select the new `messages.po` file that you downloaded in the first step.
    * The file should appear yellow with a "M" next to it to indicate that it was "Modified":

    <p align="center">
    <img width="435" src="https://gist.github.com/user-attachments/assets/a5c9532d-9f73-457c-ad33-774da1799db6" />
    </p>

    * Notice the blue circle with a "1" over the third icon. Click on that icon.
    * That will bring up the "SOURCE CONTROL" menu.

    <p align="center">
    <img width="565" src="https://gist.github.com/user-attachments/assets/a9e2d00a-af70-448f-b34e-559229339ad1" />
    </p>

    * Click on `messages.po`. This will bring up a "diff" display, showing you what's changed in the file since the last update.
    * The previous version is on the left, the incoming changes are on the right.
    * It's a good practice to visually review the changes.
    * But if there are any errors, do NOT try to correct them here. All changes MUST happen in Transifex!
    * After making a change in Transifex, repeat these steps, starting with re-downloading the `messages.po` file from Transifex.
    * If everything looks good, click the "+" symbol next to the file. This adds it to the commit you're about to submit.
    * Write a brief description of the change:
    * Begin the description with "[ES update]" (or whichever language you're updating).
    * And then a very short explanation (e.g. "minor edits", "new Feature X screens", etc).
    * Now click "Commit & Push"
    * (I need someone to document these next steps more carefully for me)
    * If this is the first time you're creating a commit for this repo:
    * It will say that you don't have permission and will ask if you'd like to fork the repo.
    * Yes, fork the repo.
    * It will then suggest a name for a new branch for this commit (e.g. "patch-1").
    * Accept whatever name it suggests.

    ---

    ### Create a pull request (PR) for your commit
    You have now updated the translations in a branch in YOUR fork of the repo. Now we need to PR your changes back to the main `seedsigner-translations` repo.

    * Return to the main repo: https://github.com/SeedSigner/seedsigner-translations
    * You should see a notice about the changes you've made to your fork in a yellow box:

    <p align="center">
    <img width="600" alt="Screenshot 2024-12-22 at 8 55 21 AM" src="https://gist.github.com/user-attachments/assets/0dff1332-aa49-405f-b908-9e1d9cdc0aa0" />
    </p>

    * Click "Compare & pull request".
    *