Skip to content

Commit

Permalink
Move "Contributing" section into dedicated document for better GitHub…
Browse files Browse the repository at this point in the history
  • Loading branch information
sferik committed Jan 26, 2013
1 parent 440b195 commit ab69b9e
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 44 deletions.
1 change: 1 addition & 0 deletions .yardopts
Expand Up @@ -2,3 +2,4 @@
--markup markdown
-
LICENSE.md
README.md
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,28 @@
## Submitting an Issue
We use the [GitHub issue tracker][issues] to track bugs and features. Before
submitting a bug report or feature request, check to make sure it hasn't
already been submitted. When submitting a bug report, please include a [Gist][]
that includes a stack trace and any details that may be necessary to reproduce
the bug, including your gem version, Ruby version, and operating system.
Ideally, a bug report should include a pull request with failing specs.

[gist]: https://gist.github.com/

## Submitting a Pull Request
1. [Fork the repository.][fork]
2. [Create a topic branch.][branch]
3. Add specs for your unimplemented feature or bug fix.
4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
5. Implement your feature or bug fix.
6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
7. Run `open coverage/index.html`. If your changes are not completely covered
by your tests, return to step 3.
8. Add documentation for your feature or bug fix.
9. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
back to step 8.
10. Add, commit, and push your changes.
11. [Submit a pull request.][pr]

[fork]: http://help.github.com/fork-a-repo/
[branch]: http://learn.github.com/p/branching.html
[pr]: http://help.github.com/send-pull-requests/
29 changes: 0 additions & 29 deletions README.md
Expand Up @@ -77,35 +77,6 @@ Here are some ways *you* can contribute:

[issues]: https://github.com/sferik/mtgox/issues

## Submitting an Issue
We use the [GitHub issue tracker][issues] to track bugs and features. Before
submitting a bug report or feature request, check to make sure it hasn't
already been submitted. When submitting a bug report, please include a [Gist][]
that includes a stack trace and any details that may be necessary to reproduce
the bug, including your gem version, Ruby version, and operating system.
Ideally, a bug report should include a pull request with failing specs.

[gist]: https://gist.github.com/

## Submitting a Pull Request
1. [Fork the repository.][fork]
2. [Create a topic branch.][branch]
3. Add specs for your unimplemented feature or bug fix.
4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
5. Implement your feature or bug fix.
6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
7. Run `open coverage/index.html`. If your changes are not completely covered
by your tests, return to step 3.
8. Add documentation for your feature or bug fix.
9. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
back to step 8.
10. Add, commit, and push your changes.
11. [Submit a pull request.][pr]

[fork]: http://help.github.com/fork-a-repo/
[branch]: http://learn.github.com/p/branching.html
[pr]: http://help.github.com/send-pull-requests/

## Supported Ruby Versions
This library aims to support and is [tested against][travis] the following Ruby
implementations:
Expand Down
33 changes: 18 additions & 15 deletions mtgox.gemspec
@@ -1,19 +1,22 @@
# encoding: utf-8
require File.expand_path('../lib/mtgox/version', __FILE__)

Gem::Specification.new do |gem|
gem.add_dependency 'faraday', '~> 0.8'
gem.add_dependency 'faraday_middleware', '~> 0.8'
gem.add_dependency 'multi_json', '~> 1.3'
gem.author = "Erik Michaels-Ober"
gem.description = %q{Ruby wrapper for the Mt. Gox Trade API. Mt. Gox allows you to trade US Dollars (USD) for Bitcoins (BTC) or Bitcoins for US Dollars.}
gem.email = 'sferik@gmail.com'
gem.files = `git ls-files`.split("\n")
gem.homepage = 'https://github.com/sferik/mtgox'
gem.name = 'mtgox'
gem.require_paths = ['lib']
gem.required_ruby_version = '>= 1.9.2'
gem.summary = %q{Ruby wrapper for the Mt. Gox Trade API}
gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
gem.version = MtGox::Version.to_s
Gem::Specification.new do |spec|
spec.add_dependency 'faraday', '~> 0.8'
spec.add_dependency 'faraday_middleware', '~> 0.8'
spec.add_dependency 'multi_json', '~> 1.3'
spec.author = "Erik Michaels-Ober"
spec.description = %q{Ruby wrapper for the Mt. Gox Trade API. Mt. Gox allows you to trade US Dollars (USD) for Bitcoins (BTC) or Bitcoins for US Dollars.}
spec.email = 'sferik@gmail.com'
spec.files = `git ls-files`.split("\n")
spec.files = %w(.yardopts CHANGELOG.md CONTRIBUTING.md LICENSE.md README.md Rakefile mtgox.gemspec)
spec.files += Dir.glob("lib/**/*.rb")
spec.files += Dir.glob("spec/**/*")
spec.homepage = 'https://github.com/sferik/mtgox'
spec.name = 'mtgox'
spec.require_paths = ['lib']
spec.required_ruby_version = '>= 1.9.2'
spec.summary = %q{Ruby wrapper for the Mt. Gox Trade API}
spec.test_files = Dir.glob("spec/**/*")
spec.version = MtGox::Version.to_s
end

0 comments on commit ab69b9e

Please sign in to comment.