Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (31 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.4 KB
Raw

Contributing

Thanks for your interest in improving the Fox Hunt Controller! Bug reports, feature ideas, and pull requests are all welcome.

Reporting bugs and requesting features

Open an issue using the matching template. For bugs, include your OS, Java version (java -version), the exact command you ran, and what happened.

Development setup

You need Java 26 or newer — nothing else.

git clone https://github.com/rbibby53/HAMRadioFoxHuntControllerJava.git
cd HAMRadioFoxHuntControllerJava
javac -d out/classes src/fox/*.java
jar --create --file fox.jar --main-class fox.Fox -C out/classes .

Testing your changes

There's no test suite (yet — contributions welcome!), so test by running:

java -jar fox.jar --help
java -jar fox.jar --callsign N0CALL --wpm 25 --repeats 1 --gap 1 --cycles 2

You should hear the callsign in morse twice, with a quiet gap between, and see a timestamped log line for each transmission. Please also exercise any option your change touches.

Pull requests

  • Branch from master and keep PRs focused on one change.
  • CI must pass — it compiles, packages, and smoke-tests the jar.
  • Match the existing code style: plain Java, 4-space indent, no external dependencies. Part of this project's appeal is that it's a single small jar with zero dependencies; please keep it that way.

Questions

Open an issue — happy to discuss ideas before you write code.