Skip to content

Commit 593fe51

Browse files
committed
roll contributring info into readme
1 parent 079c733 commit 593fe51

File tree

2 files changed

+24
-28
lines changed

2 files changed

+24
-28
lines changed

CONTRIBUTING.md

-26
This file was deleted.

README.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -130,19 +130,41 @@ See source code for examples of how to write your own reporters.
130130

131131
* ansi 1.1+ (for colorized output and progress bar output mode)
132132

133-
134133
## INSTALLATION
135134

136135
Follow the ususal procedure:
137136

138137
$ gem install turn
139138

140-
141139
## TODO
142140

143141
* Support MiniTest v5.0
144142
* General code cleanup
145143

144+
# CONTRIBUTING
145+
146+
1. Fork it
147+
2. Create your feature branch (`git checkout -b my_new_feature`)
148+
3. Commit your changes (`git commit -am 'Added some feature'`)
149+
4. Push to the branch (`git push origin my_new_feature`)
150+
5. Create a new Pull Request
151+
152+
If you are a project member please follow the same process (minus the forking). For significant changes please wait for another developer to review and merge them, whereas small contributions/fixes can be merged without review.
153+
154+
## Building
155+
156+
`gem build turn.gemspec`
157+
158+
## Solo and Cross Runners
159+
160+
An important aspect of Turn's design that needs be kept in mind, is the way
161+
_solo_ and _cross_ testing features are implemented. This is some really
162+
neat code actually (IMO), but it might be difficult to grasp with out some
163+
explanation. What turn does when using the `--solo` or `--cross` options,
164+
is <i>shell out to itself</i> using the YAML reporter. It does this repeatedly
165+
for each test, or each pair of tests, respectively, and then collates all the
166+
resulting YAML reports into a single report, which it then feeds back into the
167+
selected reporter.
146168

147169
## LICENSE
148170

0 commit comments

Comments
 (0)