diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 0de8399e..c822a270 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,14 +1,13 @@ -**Please copy the following template [here](https://github.com/ReactiveX/RxSwift/issues/new) and fill in the missing fields so we can help you as soon as possible.** -**If you don't have something to report in the following format, it will probably be easier and faster to ask in the [slack channel](http://http://slack.rxswift.org/) first.** +:warning: If you don't have something to report in the following format, it will probably be easier and faster to ask in the [slack channel](http://http://slack.rxswift.org/) first. :warning: -``` -*Short description*: +**Short description of the issue**: - description here + _description here_ -*Self contained code example that reproduces the issue*: +**Self contained code example that reproduces the issue**: +```swift code goes here // If we can't get a self contained code example that reproduces the issue, there is a big chance we won't be able @@ -16,36 +15,37 @@ // `Self contained code example` means: // * that we should be able to just run the provided code without changing it. // * that it will reproduce the issue upon running +``` -*Xcode version*: +**Xcode version**: +``` Xcode version goes here +``` -*Expected outcome*: +**Expected outcome**: - what you expect to happen goes here + _what you expect to happen goes here_ -*What actually happens*: +**What actually happens**: - what actually happens goes here + _what actually happens goes here_ -// filling in additional information below is optional, but resolving your issue could potentially be a lot faster +:warning: Fields below are optional for general issues or in case those questions aren't related to your issue, but filling them out will increase the chances of getting your issue resolved. :warning: -*Installation method*: - (so we don't waste time investigating an incorrect integration) - * CocoaPods - * Carthage - * Git submodules +**Installation method**: + - [ ] CocoaPods + - [ ] Carthage + - [ ] Git submodules -*I have multiple versions of Xcode installed*: +**I have multiple versions of Xcode installed**: (so we can know if this is a potential cause of your issue) - * yes (which ones) - * no + - [ ] yes (which ones) + - [ ] no -*Level of RxSwift knowledge*: +**Level of RxSwift knowledge**: (this is so we can understand your level of knowledge and formulate the response in an appropriate manner) - * just starting - * I have a small code base - * I have a significant code base -``` + - [ ] just starting + - [ ] I have a small code base + - [ ] I have a significant code base diff --git a/README.md b/README.md index 6329d169..8ff8259c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,10 @@ ## About Rx +**:warning: This readme describes RxSwift 3.0 version that requires Swift 3.0:warning:** + +**:warning: If you are looking for Swift 2.3 compatible version, please take a look at RxSwift ~> 2.0 versions and [swift-2.3](https://github.com/ReactiveX/RxSwift/tree/rxswift-2.0) branch :warning:** + Rx is a [generic abstraction of computation](https://youtu.be/looJcaeboBY) expressed through `Observable` interface. This is a Swift version of [Rx](https://github.com/Reactive-Extensions/Rx.NET). @@ -168,7 +172,7 @@ $ pod install Add this to `Cartfile` ``` -github "ReactiveX/RxSwift" ~> 3.0.0.alpha.1 +github "ReactiveX/RxSwift" "3.0.0.alpha.1" ``` ```