How do I run the examples?

[daveyarwood]

As someone who wants to contribute, but hasn't used mvn much, I am struggling to figure out how to run the examples to test my changes before sending a PR.

I tried using the exec-maven plugin, but I kept getting errors about the example class ("interrupt" in my case) not being found on the classpath. There must be some configuration step I am missing.

This is something that it would be nice to document, and I'll be happy to submit a PR to add documentation, if someone wouldn't mind explaining it to me.

[colini]

Since the examples are in the test tree, you have to specify the test scope when running them with the exec plugin. Once you add the exec plugin to the pom, you can run the example classes with:

mvn exec:java -Dexec.mainClass=guide.suisnail -Dexec.classpathScope=test

That should work for any example class that includes a main() method. Not all of them do.

[daveyarwood]

I tried this and it worked! Thanks!

I'm thinking about adding some Development information to the README (or perhaps a CONTRIBUTING.md) to make it easier for contributors to know how to do this.

[daveyarwood]

Action needed: CONTRIBUTING.md