LinuxSuRen / LinuxSuRen/yaml-readme
Support to generate i18n-based README files
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Go
- Stars
- 19
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Let's assume there are two README files:
* `README.md`
* `README-zh.md`
then, this project could try to find the template with the following file pattern:
* `README-zh.tpl`
* other languages
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the README generation entry point that produces README.md, then compare the requested README-zh.md and README-zh.tpl naming pattern with templates for other languages. Done means the generator discovers the language-specific templates and produces the corresponding localized README files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation, internationalization
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100