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

Sanitise README and tests to help other contributors #13

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
.flattened-pom.xml
target
.idea
*.iml
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,13 @@ void execute_code_that_manipulates_system_properties(
//code under test that reads properties (e.g. "some.property") or
//modifies them.
});

//Here the value of "some.property" is the same like before.
//E.g. it is not set.
}
```


### System.out and System.err

Command-line applications usually write to the console. If you write such
Expand Down Expand Up @@ -322,19 +322,19 @@ simply have a question about System Lambda.

## Development Guide

System Lambda is build with [Maven](http://maven.apache.org/). If you
want to contribute code than
System Lambda is built with [Maven](http://maven.apache.org/) and must be
compiled under JDK8. If you want to contribute code then

* Please write a test for your change.
* Ensure that you didn't break the build by running `mvnw test`.
* Ensure that you didn't break the build by running `mvnw clean verify -Dgpg.skip`.
* Fork the repo and create a pull request. (See [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/index.html))

The basic coding style is described in the
[EditorConfig](http://editorconfig.org/) file `.editorconfig`.

System Lambda supports [GitHub Actions](https://help.github.com/en/actions)
(Linux) and [AppVeyor](http://www.appveyor.com/) (Windows) for continuous
integration. Your pull request will be automatically build by both CI
integration. Your pull request will be automatically built by both CI
servers.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import static com.github.stefanbirkner.fishbowl.Fishbowl.ignoreException;
import static org.assertj.core.api.Assertions.assertThat;

class RestoreSystemErrChecks {
abstract class RestoreSystemErrChecks {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just a test base class and JUnit5 cannot run it. If marked abstract the IDE won't try to run it either. Obviously, its name prevents it being run by surefire, but this covers both angles.


private final MethodUnderTest methodUnderTest;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import static com.github.stefanbirkner.fishbowl.Fishbowl.ignoreException;
import static org.assertj.core.api.Assertions.assertThat;

class RestoreSystemOutChecks {
abstract class RestoreSystemOutChecks {

private final MethodUnderTest methodUnderTest;

Expand Down