Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements. #226

Merged
merged 1 commit into from
Nov 20, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This project is written in Java 8, however we are aiming for Java 11 compatibili
2. If possible, use Lombok constructor injection
* Do not use in groovy tests
* Do not use for optional dependencies `@Autowired(required = false)`
* Do not use in components which the user is expected to extend (e.g. `WebServiceHandler`/`RestServiceHandler`), to allow for simple constructor injection by users on their subclasses.
* Do not use in components, which the user is expected to extend (e.g. `WebServiceHandler`/`RestServiceHandler`), to allow for simple constructor injection by users on their subclasses.
3. If possible, write [tests](#testing) for Your code.
4. Use SonarLint to prevent issues (delete unused imports etc.)
5. When writing xsl transformations, call templates according to name, not match, in case the user wanted to use their own reporter with their own tags.
Expand All @@ -27,7 +27,7 @@ This project is written in Java 8, however we are aiming for Java 11 compatibili
Please keep the coding style uniform. (In IntelliJ IDEA select the text You want to format and press `Ctrl+Alt+L` (Windows) or `Cmd+Alt+L` (Mac).)

## Documentation
For documentation we use .md files stored in `jbehave-support-core/docs` and public APIs are documented with JavaDoc. Sometimes, it is best to just show examples, as is the case with sample stories.
For the documentation, we use .md files stored in `jbehave-support-core/docs` and public APIs are documented with JavaDoc. Sometimes, it is best to just show examples, as is the case with sample stories.

## Building the project with Maven
To build this project use the standard `mvn clean install`. We have 3 building profiles:
Expand All @@ -44,7 +44,7 @@ If you find a bug or have a question, feel free to create a new GitHub issue. Or
[![Gitter](https://badges.gitter.im/jbehave-support/community.svg)](https://gitter.im/jbehave-support/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

## Testing
We write tests primarily in groovy (with the exception of Sample stories mentioned below). The tests are running against a mock aplication located in the `jbehave-support-core-test` folder. To start it run the `jbehave-support-core-test/jbehave-support-core-test-app/src/main/java/org/jbehavesupport/core/test/app/JbehaveSupportCoreTestApplication.class`.
We write tests primarily in groovy (except for Sample stories mentioned below). The tests are running against a mock application located in the `jbehave-support-core-test` folder. To start it run the `jbehave-support-core-test/jbehave-support-core-test-app/src/main/java/org/jbehavesupport/core/test/app/JbehaveSupportCoreTestApplication.class`.

Sample stories (`jbehave-support-core/src/test/groovy/org/jbehavesupport/test/sample`) are samples for users and tests at the same time.

Expand Down
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,25 @@ along with support for [verification](jbehave-support-core/docs/General.md#verif
basic [reporting](jbehave-support-core/docs/Reporting.md).

## Contents

1. [Modules](#modules)
1. [Contributors guide](#contributors-guide)
1. [Examples](#examples)
1. [Simple use case](#simple-use-case---web-testing)
1. [Add to Java project as a Maven dependency](#add-to-java-project-as-a-maven-dependency)
2. [Create a TestConfig configuration file](#create-a-testconfig-configuration-file)
3. [Create a ui-mapping file](#create-a-ui-mapping-file)
4. [Write your story](#write-your-story)
5. [Write your story class](#write-your-story-class)
2. [Modules](#modules)

## Modules
- [core](jbehave-support-core/README.md) - details about integration and usage
- [core-test](jbehave-support-core-test/README.md) - contains details about the simple application used for integration tests

## Contributors guide
Contributors guide can be found in [CONTRIBUTING.md](CONTRIBUTING.md)

## Examples
- [examples](jbehave-support-core/docs/examples/Examples.md) - more example projects like the [simple use case](#simple-use-case---web-testing) shown below.

## Simple use case - Web testing

Expand Down Expand Up @@ -138,8 +149,3 @@ public class GoogleStory extends AbstractSpringStories {
```
**This class is runnable. When you run it, it runs your story.**

## Modules
- [Examples](jbehave-support-core/docs/examples/Examples.md) - more example projects like the [simple use case](#simple-use-case---web-testing)
- [core](jbehave-support-core/README.md) - details about integration and usage


6 changes: 5 additions & 1 deletion jbehave-support-core-test/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# Test application
This module contains test application for core integration tests.

Module contains two submodules:
Module contains three submodules:
- jbehave-support-core-test-oxm
- jbehave-support-core-test-app
- jbehave-support-core-test-app-domain

## oxm
Module contains jaxb for ws in app module.

## app-domain
Module contains data classes for REST controller.

## app
Module contains very simple spring boot application.
Application exposes H2 database:
Expand Down