-
Notifications
You must be signed in to change notification settings - Fork 32
#57 - Added CONTRIBUTING.md with info about tests and PRs. #61
Changes from 6 commits
7e0b3a3
72a2bc2
a83da6a
920c0a2
8245be0
e802e46
97d2da2
b4b07e9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
## Pull Requests | ||
|
||
All changes, no matter how trivial, must be done via pull request. Commits | ||
should never be made directly on the `develop` branch. Prefer rebasing over | ||
merging `develop` into your PR branch to update it and resolve conflicts. | ||
`master` branches are for releases only. | ||
|
||
In addition, you must follow these rules | ||
|
||
1. Create an issue before creating a PR where you describe the problem. Your issue should | ||
be limited to only one problem. | ||
|
||
2. All PR commits must reference an issue and provide a brief commit message about the commit. | ||
Here is an example | ||
``` | ||
#123456 - Fixed an issue with unhanded client errors. | ||
|
||
``` | ||
|
||
## Tests | ||
|
||
When writing a unit test, please be sure to follow these rules. | ||
|
||
1. You test has this structure | ||
|
||
``` | ||
expect{ | ||
ClassYouAreTesting().value() | ||
}.To( | ||
expectedValue, | ||
"Description of the test failure." | ||
) | ||
``` | ||
|
||
However, test failure description is not necessary, | ||
if the class you are testing implements the `Error` protocol. | ||
|
||
2. If you are creating fake classes/decorators for a test, make sure | ||
that these classes are named as `FakeXXXX`. | ||
|
||
3. The usage of the setUp() and tearDown() methods is prohibited. | ||
|
||
4. The tests must not share any test values, such as sample input values. | ||
The only exception is the test resources, like directory path or test API URL. | ||
(These must be structured according to test rule #3) | ||
|
||
See [this](http://www.yegor256.com/2016/05/03/test-methods-must-share-nothing.html) for more information. | ||
|
||
5. Your test has proper documentation, which explains what class it is testing | ||
in the format specified below | ||
|
||
``` | ||
// | ||
// This source file is part of the Web3Swift.io open source project | ||
// Copyright 2018 The Web3Swift Authors | ||
// Licensed under Apache License v2.0 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the default file template for this project, so in most cases, it should be applied automatically. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @rockfridrich I think that assert descriptions are extra, since we already have test failure descriptions. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @rockfridrich Making a template for test case sounds like a good idea but I have no clue how we can make such template useful. Lets instead draft up strict rules for the linter and mention them in this file. Test intention (description) should prefer the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @driver733 you mean without? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @Biboran Yes, I have edited the comment. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @driver733 I think it should be possible and we should do it. Lets make it a separate issue. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
// | ||
// ClassNameTest.swift | ||
// | ||
// Created by FirstName LastName on DD/MM/YYY | ||
// | ||
``` | ||
|
||
6. The name of the unit test source file has to follow this structure | ||
|
||
``` | ||
ClassNameTest.swift | ||
``` | ||
|
||
7. The name of the integration test source file has to follow this structure | ||
|
||
``` | ||
ClassNameIT.swift | ||
``` | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@driver733 How about making that a test intention rather than test failure? Tests can cascade exceptions and computational errors for a number of unknown reasons which you might not be aware of but test intention lets you know what was supposed to happen.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Biboran I agree.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Biboran Rule 1 has been edited.