|
1 | 1 | # System Rules
|
2 | 2 |
|
3 |
| -[](https://travis-ci.org/stefanbirkner/system-rules) |
| 3 | +[](https://travis-ci.org/stefanbirkner/system-rules) |
| 4 | + |
| 5 | +System Rules is a collection of JUnit rules for testing code which uses |
| 6 | +`java.lang.System`. |
| 7 | + |
| 8 | + |
| 9 | +## Installation |
| 10 | + |
| 11 | +System Rules is available from |
| 12 | +[Maven Central](http://search.maven.org/). |
| 13 | + |
| 14 | + <dependency> |
| 15 | + <groupId>com.github.stefanbirkner</groupId> |
| 16 | + <artifactId>system-rules</artifactId> |
| 17 | + <version>1.7.0</version> |
| 18 | + </dependency> |
| 19 | + |
| 20 | +Please don't forget to add the scope `test` if you're using System |
| 21 | +Rules for tests only. |
| 22 | + |
| 23 | + |
| 24 | +## Usage |
| 25 | + |
| 26 | +System Rules' documentation is stored in the `gh-pages` branch and is |
| 27 | +available online at |
| 28 | +http://stefanbirkner.github.io/system-rules/index.html |
| 29 | + |
| 30 | + |
| 31 | +## Contributing |
| 32 | + |
| 33 | +You have three options if you have a feature request, found a bug or |
| 34 | +simply have a question about System Rules. |
| 35 | + |
| 36 | +* [Write an issue.](https://github.com/stefanbirkner/system-rules/issues/new) |
| 37 | +* Create a pull request. (See [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/index.html)) |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | +## Development Guide |
| 42 | + |
| 43 | +System Rules is build with [Maven](http://maven.apache.org/). If you |
| 44 | +want to contribute code than |
| 45 | + |
| 46 | +* Please write a test for your change. |
| 47 | +* Ensure that you didn't break the build by running `mvn test`. |
| 48 | +* Fork the repo and create a pull request. (See [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/index.html)) |
| 49 | + |
| 50 | +Fishbowl supports [Travis CI](https://travis-ci.org/) for continuous |
| 51 | +integration. Your pull request will be automatically build by Travis |
| 52 | +CI. |
| 53 | + |
| 54 | + |
| 55 | +## Release Guide |
| 56 | + |
| 57 | +* Select a new version according to the |
| 58 | + [Semantic Versioning 2.0.0 Standard](http://semver.org/). |
| 59 | +* Set the new version in the `Installation` section of this readme. |
| 60 | +* `mvn release:prepare` |
| 61 | +* `mvn release:perform` |
| 62 | +* Create release notes on GitHub. |
0 commit comments