jMonkeyEngine / jMonkeyEngine/jmonkeyengine
separate examples from tests
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 4.3k
- Forks
- 1.2k
- Avg merge
- 4d 7h
- Merged PRs (30d)
- 14
Description
Plenty of apps in the jme3-examples subproject are actually tests that haven't been automated. Examples, on the other hand, are apps that illustrate how to access certain features of the Engine.
Meanwhile, the package names in jme3-examples all begin with jme3test. and the chooser app is named TestChooser. Mixing tests and examples in a single subproject has been confusing novice users of JME for a long time.
Tests which can be automated should be. Those that can't should be moved to a new subproject jme3-tests. jme3-examples would then be reserved for tutorial code, demos, sample apps, and the like. Its chooser app would be renamed, and all its source files moved to new jme3example packages.
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
Start by reviewing the jme3-examples subproject, its TestChooser app, and the jme3test package structure. Identify which apps can be automated and which belong in the proposed jme3-tests subproject. Done means automated tests are separated, tutorial and demo apps remain in jme3-examples, the chooser is renamed, and source packages use jme3example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- game-dev
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 20/100