System Rules

System Rules is a collection of JUnit rules for testing code which uses java.lang.System.

Installation

System Rules is available from Maven Central.

<dependency>
  <groupId>com.github.stefanbirkner</groupId>
  <artifactId>system-rules</artifactId>
  <version>1.12.1</version>
</dependency>

Please don't forget to add the scope test if you're using System Rules for tests only.

Usage

System Rules' documentation is stored in the gh-pages branch and is available online at http://stefanbirkner.github.io/system-rules/index.html

Contributing

You have three options if you have a feature request, found a bug or simply have a question about System Rules.

• Write an issue.
• Create a pull request. (See Understanding the GitHub Flow)
• Write a mail to [email protected]

Development Guide

System Rules is build with Maven. If you want to contribute code than

• Please write a test for your change.
• Ensure that you didn't break the build by running mvn test.
• Fork the repo and create a pull request. (See Understanding the GitHub Flow)

The basic coding style is described in the EditorConfig file .editorconfig.

System Rules supports Travis CI for continuous integration. Your pull request will be automatically build by Travis CI.

Release Guide

• Select a new version according to the Semantic Versioning 2.0.0 Standard.
• Set the new version in pom.xml and in the Installation section of this readme.
• Commit the modified pom.xml and README.md.
• Run mvn clean deploy with JDK 6 or 7.
• Add a tag for the release: git tag system-rules-X.X.X