You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
So in the `1.0.0` version each position means follow:
5
5
- 1.\*.* — **major release**, includes API groundbreaking changes (ie: your old code will not work).
6
6
-\*.1.* — **minor release**, we’ve added some new feature to the lib, but we didn’t break something in anyway (ie: everything will work as expected without any moves after update).
@@ -19,15 +19,21 @@ Please take it from the [roadmap](https://hackmd.io/G5znP3xAQY-BVc1X8Y1jSg) or f
19
19
-`swiftlint` check should goes with no warnings.
20
20
- Here’s some more detailed and human readable code style [guidelines](https://hackmd.io/8bACoAnTSsKc55Os596yCg"") (you can add there some suggestion if you’d like to).
21
21
## Tests guideline
22
-
22
+
1. Cover each new public method with tests.
23
+
2. If you’re implementing some big feature encapsulate it in Separate file.
24
+
3. Choose one of the two directory to add test case:
25
+
* `localTests` — tests which could be ran without needing to connecting to real Ethereum network.
26
+
* `remoteTests` — tests which needing connection to real Ethereum network to be ran.
27
+
4. Exclude added file from opposite `*.xctestplan` file (e.g. if you’re adding file to `localTests` please exclude it from `RemoteTests.xctestplan`.
28
+
5. Add test file to `web3swift.xcodeproj` to make it working within Carthage building system.
23
29
24
30
## Hacks & tricks & magic
25
31
### TestPlans
26
-
In ci/cd we’re using Xcode testplans feature to spread tests to local and remote one.
32
+
In ci/cd we’re using Xcode test plans feature to spread tests to local and remote one. So any time you’re adding any new test suit (file) please exclude it from `LocalTests.xctestplan` rather `RemoteTests.xctestplan` depends on what tests group it included.
27
33
### Swift package manager
28
34
Please add any files unused due build process to `excludeFiles` array in `Package.swift`.
29
35
### Carthage
30
-
Please do not forget to add & remove all new or droped files and dependencies in carthage `.xcodeproj` file if you’re working with project anywhere but carthage project.
36
+
Please do not forget to add & remove all new or dropped files and dependencies in carthage `.xcodeproj` file if you’re working with project anywhere but carthage project.
31
37
### Cocoapods
32
38
Please do not forget to add & remove all dependencies within `web3swift.podspec` file.
33
39
### GitHub actions
@@ -60,6 +66,4 @@ on:
60
66
-[ ] All public method have `///` styled comments.
61
67
-[ ] All magic or nonintuitive internal code parts are clearly explained in inline comments.
0 commit comments