Community
Participate
Working Groups
Build Identifier: The JDT Core Git repository is mirrored on at https://github.com/eclipse/eclipse.jdt.core . In its current form, it looks a bit foreign on GitHub because there are no pointers back to eclipse.org where you would find relevant information about the project. I would like to propose adding a README file to improve this situation. You can see this in action at https://github.com/bokowski/eclipse.jdt.core . As per http://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions, the commit URL is https://github.com/bokowski/eclipse.jdt.core/commit/03161cdee6bf596f1935d9b08463d500ddd8d7db . Since I am a committer on the Eclipse top-level project, there is no need for the usual IP process dance. Reproducible: Always
Actually, to see it on github.com you need to look at the feature branch I created: https://github.com/bokowski/eclipse.jdt.core/tree/add_readme This change adds a link at the top ("read more") and displays the complete readme file contents at the bottom of the page.
(In reply to comment #0) > The JDT Core Git repository is mirrored on at > https://github.com/eclipse/eclipse.jdt.core . In its current form, it looks a > bit foreign on GitHub because there are no pointers back to eclipse.org where > you would find relevant information about the project. This is probably true for other repos as well. Orion server repo (https://github.com/eclipse/orion.server) just includes a link at the top, which is probably enough ? (Though I don't know how to add a link there)
(In reply to comment #2) > This is probably true for other repos as well. Yes - you have to start somewhere, though :-) > Orion server repo > (https://github.com/eclipse/orion.server) just includes a link at the top, > which is probably enough ? (Though I don't know how to add a link there) I can add a link for you there (since I am one of the administrators of the Eclipse account at GitHub). I don't think it is enough though - see here for a readme file that sets a really good example: https://github.com/twitter/bootstrap (or any other of Twitter's open source projects).
(In reply to comment #3) > I don't think it is enough though - see here for a > readme file that sets a really good example: > https://github.com/twitter/bootstrap (or any other of Twitter's open source > projects). I am just loath to duplicate information that we already have in our websites e.g. http://www.eclipse.org/jdt/core/index.php and http://www.eclipse.org/jdt/ui/index.php. But I suppose a readme file (like the one you added) with a minimal description and a few links would be ok.
Wonder if something could be done on the GitHub side? When you look at https://github.com/eclipse/ it clearly says "Mirrored from" but nothing in the https://github.com/eclipse/eclipse.jdt.core page.
(In reply to comment #5) > When you look at https://github.com/eclipse/ it clearly says "Mirrored from" > but nothing in the https://github.com/eclipse/eclipse.jdt.core page. It does have the 'mirrored from' info, right at the top " eclipse / eclipse.jdt.core mirrored from git://git.eclipse.org/gitroot/jdt/eclipse.jdt.core.git " ...but it is hard to notice. Even I did not notice it in first glance :-) If at all anything needs to be done, there should be a link to the project dashboard - http://eclipse.org/projects/project.php?id=eclipse.jdt.core. Links to all other places are available here.
(In reply to comment #6) > If at all anything needs to be done, there should be a link to the project > dashboard - http://eclipse.org/projects/project.php?id=eclipse.jdt.core. Links > to all other places are available here. Yup, that and adding the readme file as well. We can't add the link though right? Jay, can you add the readme file to the repo? Thanks!
I was still not 100% convinced about adding a readme, but then Remy mentioned to me "too bad this is Git the repo can be anywhere", which makes a fairly strong case. Boris, do you plan to add a README file to Platform/UI repo - https://github.com/eclipse/eclipse.platform.ui ? :-) My take is that would be a good place to start, rest of us can then follow suit.
Is there a consensus on what needs to be included in the README? And is there a way to do this without recreating (copy/paste i.e.) the content? Not that I think the README file would need to be touched often, but just wondering.
(In reply to comment #8) > Boris, do you plan to add a README file to Platform/UI repo - > https://github.com/eclipse/eclipse.platform.ui ? :-) > > My take is that would be a good place to start, rest of us can then follow > suit. done! you can now follow suit ;-)
(In reply to comment #10) > done! you can now follow suit ;-) Thanks :-) In case any one wants to see this, here is the link http://git.eclipse.org/c/platform/eclipse.platform.ui.git/tree/README.md (In reply to comment #9) > Is there a consensus on what needs to be included in the README? I think what Boris added looks reasonable to me - https://github.com/bokowski/eclipse.jdt.core/tree/add_readme. I would just make one change, for more information I would link it to the Project Dashboard( http://eclipse.org/projects/project.php?id=eclipse.jdt.core).
Added the README.md in master, which can be viewed here: http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/tree/README.md Should anyone want any change, let me know.
Update: The README contents can be verified here: https://github.com/eclipse/eclipse.jdt.core
Thanks!
