-
Notifications
You must be signed in to change notification settings - Fork 188
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
Blank contributing file is confusing #651
Comments
Oh yeah. Lots of info in CONTRIBUTING.md <!-- all commented out --> I agree that is confusing. I didn't really understand why @michael63-osm decided to comment out the whole thing. There's certainly some sentences there which are still valid. I'm happy to have a go at doing a less brutal pruning of the info if that helps. I see in the discussion here he said |
Sorry for the confusion, I was not really aware that people pay attention to this file. The modification to that file was around the time when we started writing a couple of documents for people who want to help: You will be directed to these pages when you click on the pencil icon at the top right of each page. What is missing is a guide how to contribute new English contents. I would prefer to add that one to the other two documents, wouldn't mind including them all as links in CONTRIBUTING.md but am of course open to other suggestions. The previous translation workflow outlined in CONTRIBUTING.md is no longer supported since we switched to Transifex. |
Ah yes. There is quite a lot of 'contribute' info elsewhere. Actually a good generic explanation I hadn't noticed is the three paragraphs here: https://github.com/hotosm/learnosm#contributing . Also, as you say, "when you click on the pencil icon" https://learnosm.org/en/contribute/ there's another generic single paragraph on a "contribute" homepage. |
I would rather replace its contents by links to a documentation if it exists elsewhere |
https://github.com/hotosm/learnosm/blob/gh-pages/CONTRIBUTING.md - maybe it would be better to delete outdated content? It will be kept in git history
Now it is quite confusing - on visiting file it is blank. Note that this file is linked by github - see for example below bottom of a new issue form ( https://github.com/hotosm/learnosm/issues/new )
On viewing code ( https://raw.githubusercontent.com/hotosm/learnosm/gh-pages/CONTRIBUTING.md ) one may see the text but new contributor is unable to guess which part are outdated.
Is everything outdated there? Then maybe delete it and maybe open new issue describing what should be documented there.
The text was updated successfully, but these errors were encountered: