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

Inconsistent package structure in the samples. #7

Open
Naoghuman opened this issue Nov 30, 2018 · 3 comments
Open

Inconsistent package structure in the samples. #7

Naoghuman opened this issue Nov 30, 2018 · 3 comments

Comments

@Naoghuman
Copy link
Contributor

Inconsistent package structure in the samples.

  • Some projects have package, other not.
  • It's a anti pattern to use the default package.
  • All sample projects should have the same base package structure (also the cli samples).

Info:
https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html

@jperedadnr
Copy link
Collaborator

I'm aware of this, but only the samples under the HelloFX main category are the ones without package.

These samples were initially the only ones available in the Docs, meant to do a quick start with JavaFX 11. The focus is on the class itself, and how you can compile it and run it, not in the project structure, package names or other usual conventions.

Adding a hellofx package (for instance), will lead to the same exact samples we have under the CommandLine category. But maybe that's ok? It will still match the Docs structure.

@Naoghuman
Copy link
Contributor Author

Sure it's okay. When we look the most samples are similar. We have over 20 samples and when momentary some are equals then is that okay from my view of sight.

What are the goals from these examples? The examples should show how to do the specific topic in JavaFX with different build tools or with the command line or ... .

From my personal view the samples should not only show the specific topic, also the best practice how to do it in JavaFX 11. So we need later also additional commentary, JavaDoc and the license in the samples, but thats are points for another issue.

@Naoghuman
Copy link
Contributor Author

So the question is should the package structure for the HelloFX project updated or not?
If yes we need then also an issue in openjfx/openjfx-docs for the update from the links in the guide.

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