search

globocom / huskyCI

Performing security tests inside your CI
https://huskyci.opensource.globo.com
BSD 3-Clause "New" or "Revised" License
572 stars 137 forks source link

GitHub Actions for Automatic README Translation and Pull Request #574

Open fguisso opened 1 year ago

fguisso commented 1 year ago

  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 commented 1 year ago

can I attempt this?