redhat-developer / redhat-developer/vscode-java
Document how to work with a non-"project" set of files
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 546
- Avg merge
- 20h 1m
- Merged PRs (30d)
- 11
Description
I'm very new to Java development and am learning by simply creating a few ad hoc files. I'm following a book that uses a folder/package structure of "ch01/sec01" which I mimicked in my VSC folder structure. I noticed that the plugin would always give an error for:
package ch01.sec01;
Saying that the package was actually "" instead. I ignored this error and just carried on but it bothered me. :) A friend pointed out that if I moved my files into a "src" folder, this would go away, and apparently this is the default if you make a new Java project, but as I was just playing around and not really doing a 'project', I never knew this was an issue.
My recommendation is that a quick note be adding to the Troubleshooting section of the readme.
Steps To Reproduce
- Work with Java files w/o first making a Java project
- Note that even though you have the right package, it gets flagged as an error.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the README and locate the Troubleshooting section. Add a concise note explaining the package warning when Java files are used outside a project structure, including the role of a src folder, then verify that the new guidance matches the reported reproduction steps.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, vscode
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100