jMonkeyEngine / jMonkeyEngine/wiki

sample code in tutorials should match the SDK's "JME3 Tests" project template

Open
#96 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Handlebars
Stars
33
Forks
61
PR merge metrics
No merged PRs in 30d

Description

See https://github.com/jMonkeyEngine/jmonkeyengine/issues/1124, filed by @nav9. They missed part about "All example code is included in the jMonkeyEngine SDK" and tried copy-pasting code from the beginner tutorials. That ought to work, but it didn't. They mentioned 2 sorts of problems:

  1. small errors in the code
  2. non-breaking space characters

I assume the SDK build process somehow copies the Java code in the "JME3 Tests" project template from the jme3-examples sub-project of the Engine, so that's an important piece of this issue. Whenever changes are made the tutorial code, it's vital to replicate those changes in jme3-examples. This will ensure that the code actually compiles.

Similarly, it's important that changes to certain jme3-examples classes (the ones used in the wiki) get reflected in the wiki. Perhaps we should add prominent reminders to the Java code.

A related topic at the Forum:
https://hub.jmonkeyengine.org/t/hellocollision-will-need-update-for-3-2/39730/7

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the beginner tutorials, the jme3-examples sub-project, and the SDK’s "JME3 Tests" project template to compare their Java samples. Check for the reported code errors and non-breaking spaces, then review the wiki classes used by the tutorials. Done means the tutorial and template code stays synchronized and compiles in the SDK context.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.