Community
Participate
Working Groups
The JDT Core README looks quite unappealing, especially when viewed on GitHub (https://github.com/eclipse/eclipse.jdt.core). One of the two links even points to a page saying that the project has been archived, which is confusing. It would probably be beneficial to provide a more welcoming and informative landing page, if possible with some additional links. Even though it's probably not perfect, the JDT UI README (view at https://github.com/eclipse/eclipse.jdt.ui) does a significantly better job at guiding users.
New Gerrit change created: https://git.eclipse.org/r/134176
(In reply to Eclipse Genie from comment #1) > New Gerrit change created: https://git.eclipse.org/r/134176 I haven't addressed the "very basic" concern. But this fixes the incorrect link to the project's page and I have also updated the JDT Core's wiki page [1] to fix couple of outdated links. Pretty much everything that I can think of (and is mentioned on the JDT UI readme) can be found in [1] and I am not very keen on duplicating here. [1] https://wiki.eclipse.org/JDT_Core
Gerrit change https://git.eclipse.org/r/134176 was merged to [master]. Commit: http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/commit/?id=e53d022d9aa95999d4efaf30102cd1ba42af5129
If people are still keen on getting all the information on the readme itself, feel free to edit the file to make it similar to the JDT UI repo. I am keeping this bug open for a day or two.
Thanks for your response and that link edition. Could we get the markdown right so that the links appear correctly on GitHub (rather than displaying the text in square brackets and a number link floating next to it)? I understand your point of view regarding information duplication, however, as one of the main JDT repositories, I've got the feeling that the README is currently very minimalistic. If you compare to GitHub landing pages for the repositories of other popular IDEs, they're much more user friendly, welcoming and visually appealing. I happen to be one of the maintainer of the Shields.io project, we provide most of those badges you see on many open-source READMEs nowadays. One idea would be to add a few of them, as they are both informative and bring some visuals to the page. For instance, we could display things such as: - the status of the project's Jenkins build: https://img.shields.io/jenkins/s/https/ci.eclipse.org/jdt/job/eclipse.jdt.core-Gerrit.svg - the status of tests: https://img.shields.io/jenkins/t/https/ci.eclipse.org/jdt/job/eclipse.jdt.core-Gerrit.svg - various statistics about the repository, for example the last commit date: https://img.shields.io/github/last-commit/eclipse/eclipse.jdt.core.svg - or even handles to social media: https://img.shields.io/twitter/follow/EclipseJavaIDE.svg?label=Follow%20@EclipseJavaIDE&style=social
