Add main README for jdt.debug and clean-up CONTRIBUTING file #532
Conversation
| JDT Debug implements Java debugging support and works with any JDPA-compliant target Java VM. | ||
| It is implemented on top of the language independent "debug model" provided by the platform debugger. | ||
| JDT debug provides the following debugging features: | ||
|
|
||
| - Launching of a Java VM in either run or debug mode | ||
| - Attaching to a running Java VM | ||
| - Expression evaluation in the context of a stack frame | ||
| - Scrapbook pages for interactive Java code snippet evaluation | ||
| - Dynamic class reloading where supported by Java virtual machine |
There was a problem hiding this comment.
This section is mainly based on the content of
https://eclipse.dev/eclipse/debug/index.php
CONTRIBUTING
Outdated
| See https://github.com/eclipse-jdt/.github/blob/main/CONTRIBUTING.md |
There was a problem hiding this comment.
is that file needed at all? when its deleted it shout be automatically taken from .github
There was a problem hiding this comment.
Removal will be a good choice.
There was a problem hiding this comment.
is that file needed at all? when its deleted it shout be automatically taken from .github
I cannot say if there are legal requirements or alike and I also don't know if it's inherited. I just know that many, if not all, repos in the platform, equinox, PDE organization have it. Maybe just to avoid dead links?
But I removed it now.
There was a problem hiding this comment.
It was a honest question. I know from https://docs.github.com/de/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors that https://github.com/eclipse-jdt/eclipse.jdt.ui/contribute does link it. But i do not know who would know how to go to that URL, i don't see a link to it anywhere and have never used it myself
| For more information about JDT Debug refer to the [JDT Debug website](https://eclipse.dev/eclipse/debug/index.php). | ||
| For general information about JDT and important links, refer to the [JDT wiki page](https://github.com/eclipse-jdt/eclipse.jdt.core/wiki) or the [JDT project overview page](https://projects.eclipse.org/projects/eclipse.jdt). | ||
|
|
||
| ## Contributing |
There was a problem hiding this comment.
does this file need a Contributing section? The existing of Contributing.md should be self explaining
There was a problem hiding this comment.
I agree with @jukzi on this. looks good without Contributing section
There was a problem hiding this comment.
does this file need a Contributing section? The existing of Contributing.md should be self explaining
The contributing.md is now removed and even if it's inherited from the organization I think it's good to have a few words about contributions and to provide the link to the orga's contributing section explicitly.
Furthermore I wanted to add the Oomph setup button for the setup to be added for repository (see eclipse-platform/eclipse.platform.releng.aggregator#2430) in that section in a follow-up PR, similar to how it is e.g. in the platform repository:
https://github.com/eclipse-platform/eclipse.platform.ui/?tab=readme-ov-file#how-to-contribute
Therefore I would be in favor to keep this.
|
@SougandhS can you review, please? |
Sure @jukzi |
The content is based on the content of the corresponding files in jdt.core/ui.
HannesWell
force-pushed
the
add-readme
branch
from
46e1cfd
to
14c1070
Compare
|
lets try |
|
https://github.com/eclipse-jdt/eclipse.jdt.debug/contribute now shows the .github link :-) |
|
Thanks for submitting.
That's nice, I didn't know this was possible. |
yes, please. While Readme makes sense per repository, the governing rules belong to the organization and are same for all repos the org owns. |
Created eclipse-platform/eclipse.platform.releng.aggregator#2448 to track that. |
What it does
Add main README for jdt.debug and clean-up CONTRIBUTING file.
The content of both is based on the content of the corresponding files in jdt.core/ui.
Author checklist