-
Notifications
You must be signed in to change notification settings - Fork 2
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
Check for bilingual README and LICENSE; generate PR if necessary #125
Comments
@anthonyfok @DamonU2 I am prototyping the bilingual README files in the national-human-settlement repo. Feedback welcomed. |
I like it. I think that's a very clear way to implement it, and it should keep things simple for imports. |
I'd like to echo what @DamonU2 said about the bilingual README files in the OpenDRR/national-human-settlement, i.e. the naming of README.md and LISEZMOI.md, which is very clear and very fair to both languages. For MIT License, since there is no official French translation, leaving it as a single file named LICENSE is ideal. Regarding bilingual licence files such as the "Open Government Licence - Licence du gouvernement ouvert – Canada As for LICENCE-en.txt vs LICENSE-en.txt, the latter seems more common due to the prevalence of American English, though the former is more Canadian and is used in the Open Government Licence name itself, though I suspect lots of Canadians often use American spelling too. I personally am fine with either spelling. Feedback welcomed too! :-) |
So how can we enforce this? A template repo perhaps but ideally we would be able to run a script to at least report on which repos don't have a README in both official languages. |
We can get a list of all of the repos from the github api. I'm not sure what the best way to check for a readme would be. We could do this in a github action, checkout each repo, and check for the files, but there is probably a better way. Maybe try to access the file and use error handling? |
Not a bad idea. I guess we could loop through the repos and check for a LISEZMOI.md file, if not create an issue... |
So far the action is checking for README.md and LISEZMOI.md, I had to remove the LICENSE check, as it was exceeding the max API calls allowed. Results are here: https://github.com/DamonU2/DamonU2.github.io/runs/5058092220?check_suite_focus=true |
Open an issue would be ideal. |
Use GitHub actions for checking the existence of README.md and LICENSE in all OpenDRR repos, and otherwise create a PR with French translation too, e.g. via API calls to DeepL.com.
Special thanks to Joost (@jvanulde) for the idea!
See the test at
Naming conventions:
README.md
andLISEZMOI.md
LICENSE
for single-language license like the MITLICENCE-en.txt
andLICENCE-fr.txt
for bilingual licence such as "Open Government Licence - Canada -- Licence du gouvernement ouvert – Canada" (GitHub does recognize both BrE and AmE spellings)Suggested starting points:
The text was updated successfully, but these errors were encountered: