roboticslab-uc3m / questions-and-answers

A place for general debate and question&answer
https://robots.uc3m.es/developer-manual/appendix/repository-index.html
2 stars 0 forks source link

Improve CONTRIBUTING.md #5

Closed jgvictores closed 2 years ago

jgvictores commented 7 years ago

Sample: https://github.com/roboticslab-uc3m/teo-main/blob/develop/CONTRIBUTING.md

jgvictores commented 7 years ago

Also look at: http://discourse.ros.org/faq

jgvictores commented 7 years ago

And: http://wiki.ros.org/Support

David-Estevez commented 7 years ago

Those ROS guides look really nice...

jgvictores commented 7 years ago

Yet another good reference: https://github.com/blog/2267-introducing-github-community-guidelines

jgvictores commented 7 years ago

Added at 47a8cc6c26080608da6fca938e0ffbf41b469795, but must improve.

jgvictores commented 7 years ago

Yet another reference: http://wiki.ros.org/action/info/BestPractices

PeterBowman commented 5 years ago

Yet another good reference: https://github.com/blog/2267-introducing-github-community-guidelines

GitHb has made available a handy wizard at Insights > Community to choose and upload a code of conduct statement.

PeterBowman commented 2 years ago

Sample: https://github.com/roboticslab-uc3m/teo-main/blob/develop/CONTRIBUTING.md

I believe all our CONTRIBUTING.md files have been synchronized with that one. Moreover, when this file is missing in a specific repo, the global one is pulled from roboticslab-uc3m/.github. @jgvictores what next?

jgvictores commented 2 years ago

IMHO: 1) Update (not mandatory, forget it too tedious): http://robots.uc3m.es/index.php/TEO -> https://apps.robots.uc3m.es/index.php/TEO (I'll open an issue regarding the validness of the certificate) 2) Close this issue ^^

PeterBowman commented 2 years ago

OK, but I'd rather forget about the wiki altogether and only recommend a GitHub search. I believe the most relevant stuff has been already migrated (?).

PS certain links stopped working after you deleted the redirections I had prepared at https://github.com/roboticslab-uc3m/questions-and-answers/issues/91#issuecomment-805120205. For instance, see TEO Cluster: Network, IP, MAC and PC specification list. The wiki is archived, therefore no one can edit and fix that link.

jgvictores commented 2 years ago

OK, but I'd rather forget about the wiki altogether and only recommend a GitHub search. I believe the most relevant stuff has been already migrated (?).

Perfect!

PS certain links stopped working after you deleted the redirections I had prepared at #91 (comment).

Sorry about that again!

For instance, see TEO Cluster: Network, IP, MAC and PC specification list. The wiki is archived, therefore no one can edit and fix that link.

Oh, that was https://github.com/roboticslab-uc3m/teo-developer-manual/issues/19 anyway ^^ Some day we'll find a decent mechanism for that.

PeterBowman commented 2 years ago

Done as part of https://github.com/roboticslab-uc3m/questions-and-answers/issues/93#issuecomment-1001805412.

As a side note, whenever a repo lacks CONTRIBUTING.md, it is automatically pulled from https://github.com/roboticslab-uc3m/.github/. Also, it is possible to show the contents of a README.md file added there on the org's main page (https://github.com/roboticslab-uc3m).