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.

Sign up for GitHub

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

Jump to bottom

Add main README for jdt.debug and clean-up CONTRIBUTING file #532

Merged
merged 1 commit into from
Oct 10, 2024
Merged

Add main README for jdt.debug and clean-up CONTRIBUTING file #532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 0 additions & 59 deletions CONTRIBUTING
View file
Open in desktop

This file was deleted.

32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# JDT Debug

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
Comment on lines +3 to +11
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is mainly based on the content of
https://eclipse.dev/eclipse/debug/index.php


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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this file need a Contributing section? The existing of Contributing.md should be self explaining

Copy link
Contributor

@SougandhS SougandhS Oct 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @jukzi on this. looks good without Contributing section
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


[Contributions are always welcome!](https://github.com/eclipse-jdt/.github/blob/main/CONTRIBUTING.md)

Please bear in mind that this project is almost entirely developed by volunteers.
If you do not provide the implementation yourself (or pay someone to do it for you), the bug might never get fixed.
If it is a serious bug, other people than you might care enough to provide a fix.

## License

[Eclipse Public License (EPL) v2.0](https://www.eclipse.org/legal/epl-2.0/)

## Links

- https://github.com/eclipse-jdt/eclipse.jdt.core/wiki
- https://github.com/eclipse-jdt/.github/blob/main/CONTRIBUTING.md
- https://projects.eclipse.org/projects/eclipse.jdt
Loading