julep
julep copied to clipboard
[Good First Issue] Add a github action that automatically translates the README into chinese, japanese, and french languages
trafficstars
Add a GitHub Action for Automatic README Translation
We'd like to make our project more accessible to non-English speakers by automatically translating our README into Chinese, Japanese, and French. This task involves setting up a GitHub Action to handle the translation process whenever the main README is updated.
Objective
Create a GitHub Action workflow that:
- Detects changes to the main
README.mdfile - Translates the content into Chinese, Japanese, and French
- Updates (or creates if they don't exist) the corresponding
README-CN.md,README-JP.md, andREADME-FR.mdfiles
Implementation Suggestions
- Configure the workflow to trigger on changes to
README.md - Implement the translation logic using a script (Python, Node.js, or shell script)
- Commit and push the translated files back to the repository
Definition of Done
- GitHub Action workflow is created and functional
- README is automatically translated into Chinese, Japanese, and French when updated
- Translated files are correctly named and placed in the repository
- Action runs successfully on test commits
This is a great opportunity to learn about GitHub Actions and work with translation APIs. If you have any questions or need further clarification, please don't hesitate to ask in the comments!