Github user metatype commented on a diff in the pull request: https://github.com/apache/geode-examples/pull/4#discussion_r113305384 --- Diff: README.md --- @@ -17,29 +17,59 @@ limitations under the License. [<img src="https://geode.apache.org/img/apache_geode_logo.png" align="center"/>](http://geode.apache.org) -[](https://travis-ci.org/apache/geode-examples) [](https://www.apache.org/licenses/LICENSE-2.0) +[](https://travis-ci.org/apache/geode-examples) [](https://www.apache.org/licenses/LICENSE-2.0) # Apache Geode examples -This is the home of Apache Geode examples that are bundled with the project. Contributions<sup>[2]</sup> and corrections are welcome. Please talk to us about your suggestions at [dev@geode.apache.org](mailto:dev@geode.apache.org) or submit a [pull request](https://github.com/apache/geode/pull/new/develop). +This is the home of Apache Geode examples that are bundled with the project. +Contributions<sup>[2]</sup> and corrections are welcome. Please talk to us +about your suggestions at [dev@geode.apache.org](mailto:dev@geode.apache.org) +or submit a [pull request](https://github.com/apache/geode/pull/new/develop). -## Example requirements +## Adding a new example -All examples: +Follow this approach to add a new example: -* Need to be testable. Use unit tests, integration tests or whatever is applicable. Tests will run through the project's CI. --- End diff -- Here's my thesis: `gradle runAll` is the integration test. The model for building an example is prescriptive. I want to be able to run the example and any tests from my IDE. I want to show users how to use `gfsh` to start servers. Wherever we can I want to distill an example into a single pane of code. We should write unit tests as needed while being careful that those tests don't get in the way of learning. IMO the two examples we have today don't need additional unit tests. Do you agree? Feedback welcome!
--- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---