Skip to content

Commit

Permalink
add "Tests" section to contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jpsim committed Dec 11, 2016
1 parent 55dc220 commit 3dcfdf5
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,30 @@ immediately, but this should be the exception, not the norm._

### Submodules

This SwiftLint repository uses submodules for its dependencies.
This SwiftLint repository uses submodules for its dependencies.
This means that if you decide to fork this repository to contribute to SwiftLint,
don't forget to checkout the submodules as well when cloning, by running
`git submodule update --init --recursive` after cloning.

See more info [in the README](https://github.com/realm/SwiftLint#installation)
See more info [in the README](https://github.com/realm/SwiftLint#installation).

### Tests

SwiftLint supports building via Xcode and Swift Package Manager on macOS, and
with Swift Package Manager on Linux. When contributing code changes, please
ensure that all three supported build methods continue to work and pass tests.

```shell
$ script/cibuild
$ swift test
$ make docker_test
```

## Rules

New rules should be added in the `Source/SwiftLintFramework/Rules` directory.

Rules should conform to either the `Rule` or `ASTRule` protocols.
Rules should conform to either the `Rule` or `ASTRule` protocols.
To activate a rule, add the rule to `masterRuleList` in `MasterRuleList.swift`.

All new rules or changes to existing rules should be accompanied by unit tests.
Expand Down

0 comments on commit 3dcfdf5

Please sign in to comment.