Skip to content
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

Create the project page description to contribute to the IDE #5

Open
opcoach opened this issue Sep 18, 2024 · 5 comments
Open

Create the project page description to contribute to the IDE #5

opcoach opened this issue Sep 18, 2024 · 5 comments

Comments

@opcoach
Copy link
Contributor

opcoach commented Sep 18, 2024

Is your feature request related to a problem? Please describe.
We should provide a list of the different projects included in the IDE

  • description
  • link to the installer setup
  • nb of first issues
  • ...

Describe the solution you'd like
Refered in the main contribution page, it should be displayed in a single table with link inside

Describe alternatives you've considered
May be a simple table in the main page

Additional context
Use the content of https://docs.google.com/spreadsheets/d/1dr-R-o9IUDyet5bMAAWg6FIZ-GPNZ0gRgtmd6k8DvRU/edit?gid=0#gid=0

@opcoach
Copy link
Contributor Author

opcoach commented Sep 18, 2024

Just a try :

Project Github URL Readme COC Total Repositories Java Code Repositories Deprecated Repositories Contribution Page Active Contributors Opened Issues Good First Issues Contribution Tooling Pending PR New Issue Process
Eclipse Foundation GitHub README.md 273 142 8183 146
Eclipse Platform GitHub ReadME.md 24 6 11 CONTRIBUTING.md 815 6 112
EGit GitHub README 6 2 1 EGit Contributor Guide 23 0 Gerrithub 115
JDT GitHub README.md 8 4 0 CONTRIBUTING.md 709 3
PDE GitHub README.md 5 1 1 CONTRIBUTING.md 209 0
Equinox GitHub README.md 8 2 2 CONTRIBUTING.md 81
EMF GitHub README.md in repository 4 1 0 2 0
M2E GitHub README.md 9 CONTRIBUTING.md 286
Oomph GitHub CONTRIBUTING.md 9 0 1 GitHub standard
Otterdog GitHub README 1 1 contributing.md

Project Descriptions

Eclipse Foundation

The Eclipse Foundation manages a wide range of open-source projects. Learn more.

Eclipse Platform

The Eclipse Platform is the core framework for the Eclipse IDE. Learn more.

EGit

EGit is an Eclipse Team provider for Git. Learn more.

JDT

JDT (Java Development Tools) is part of the Eclipse IDE for Java developers. Learn more.

PDE

PDE (Plug-in Development Environment) is a set of tools for developing Eclipse plugins. Learn more.

Equinox

Equinox is the Eclipse OSGi framework. Learn more.

EMF

The Eclipse Modeling Framework (EMF) is a framework for building data models. Learn more.

M2E

M2E provides integration between Eclipse and Maven. Learn more.

Oomph

Oomph simplifies the installation of Eclipse IDEs. Learn more.

Otterdog

Otterdog is a tool for managing GitHub organizations using configuration as code. Learn more.

@opcoach
Copy link
Contributor Author

opcoach commented Oct 7, 2024

Other idea

Project Description Github URL Readme Installer Setup Review
Eclipse Platform The eclipse kernel See more GitHub README.md Setup PR

@HannesWell
Copy link
Contributor

Other idea

I think the reduced information is sufficient. But if that currently has the same information, i.e. the GitHub repo links multiple times.
Since the README is displayed very prominently on GH repos I would skip that column.

In the project column we could/should link the PMI entry. In case of platform it's
https://projects.eclipse.org/projects/eclipse.platform

And we should also consider that many Eclipse projects have more than one repository.
In case of eclipse-platform it's for example

So we should maybe have sub-elements e.g.:

Or maybe this can be also be made nicely in a table.

And instead of linking the raw setup we could also link the contributing section that has the 'Setup button':
https://github.com/eclipse-platform/eclipse.platform?tab=readme-ov-file#how-to-contribute

Then the target would also be more appealing if one clicks it instead of just copying it.

@opcoach
Copy link
Contributor Author

opcoach commented Oct 10, 2024

Yes this is good ideas. Projects and repositories must be distinguished.

@opcoach
Copy link
Contributor Author

opcoach commented Oct 11, 2024

I put a sample on my fork here : https://github.com/opcoach/.github/blob/update1/projects.md for some projects before adding the others

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants