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

GitHub Actions for Automatic README Translation and Pull Request #574

Open
fguisso opened this issue Oct 17, 2023 · 1 comment
Open

GitHub Actions for Automatic README Translation and Pull Request #574

fguisso opened this issue Oct 17, 2023 · 1 comment

Comments

@fguisso
Copy link
Member

fguisso commented Oct 17, 2023

  1. Problem Description:

    • The README file is currently only available in one language, and there is a need to make it accessible to a broader audience by providing translations.
  2. Steps to Reproduce:

    • N/A
  3. Expected Behavior:

    • Implement a GitHub Actions workflow that triggers whenever the README file receives a change. This workflow automatically translates the README into Portuguese and creates a pull request for code review and merge.
  4. Current Behavior:

    • The README is available in a single language, and the translation process is manual and time-consuming.
  5. Proposed Changes:

    • Set up a GitHub Actions workflow that listens for changes to the README file.
    • On any change, automatically translate the README into Portuguese using a translation tool.
    • Create a pull request with the translated README, ready for code review and merge.
  6. Dependencies:

    • GitHub Actions must be enabled for the repository.
    • Access to a translation tool or service for automatic translation.
  7. Testing:

    • Test the GitHub Actions workflow by making changes to the README file and verifying that the translation and pull request creation processes are triggered automatically.
  8. Documentation Updates:

    • Update the project documentation to inform contributors and maintainers about the new GitHub Actions workflow.
    • Provide information on the translation tool used and any considerations for translation accuracy.
  9. Expected Impact:

    • This GitHub Actions workflow will streamline the process of translating the README into Portuguese, making the project more accessible to a wider audience.
  10. Additional Information:

    • Consider setting up a review process for the translated content to ensure accuracy and appropriateness.
    • Provide guidance for contributors on handling translations for future README changes.

Note: Ensure that the translation process adheres to quality standards, and consider involving native speakers or language experts in the review process.

@georgettica
Copy link

can I attempt this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants