Browse files

Added how-to-contribute notes

  • Loading branch information...
1 parent 63432ce commit 8f09764c873de1bd00c36f27d7da7987005333d5 @copiousfreetime committed Jul 22, 2011
Showing with 70 additions and 3 deletions.
  1. +1 −0 .gitignore
  2. +7 −0 README.asciidoc
  3. +13 −3 Rakefile
  4. +13 −0 tasks/bundler.rake
  5. +36 −0 tasks/contribute.rake
View
1 .gitignore
@@ -17,3 +17,4 @@ man/*.1
*.gemspec
work/
*.css
+Gemfile*
View
7 README.asciidoc
@@ -132,6 +132,13 @@ View which manual?
>
---------------------------------
+Development
+-----------
+If you want to do development on stickler, I suggest using
+https://rvm.beginrescueend.com/[RVM] and creating a gemset for stickler.
+
+Then run 'rake how_to_contribute'
+
Credits
-------
View
16 Rakefile
@@ -1,7 +1,9 @@
begin
+ USING_BONES_VERSION = '3.7.0'
require 'bones'
rescue LoadError
- abort '### Please install the "bones" gem ###'
+ load 'tasks/contribute.rake'
+ Rake.application.invoke_task( :help )
end
task :default => 'spec:run'
@@ -36,16 +38,24 @@ Primarily, you would want to use Stickler if:
3. You want both (1) and (2) in the same server.
_
+ # I'm explicitly controlling the version of bones.
+
depend_on 'sinatra' , '~> 1.2.1'
depend_on 'addressable', '~> 2.2.4'
depend_on 'excon' , '~> 0.5.8'
depend_on 'trollop' , '~> 1.16.2'
depend_on 'logging' , '~> 1.5.0'
- depend_on 'bones' , '~> 3.6.5', :development => true
+ depend_on 'rake' , '~> 0.9.2'
+ depend_on 'bones' , "~> #{USING_BONES_VERSION}", :development => true
depend_on 'rack-test' , '~> 0.5.7', :development => true
depend_on 'bones-extras', '~> 1.3.0', :development => true
depend_on 'builder' , '~> 3.0.0', :development => true
- depend_on 'rspec' , '~> 2.5.0', :development => true
+ depend_on 'rspec' , '~> 2.6.0', :development => true
}
+
+# Sorry Tim, I need to manage my own bones version
+::Bones.config.gem._spec.dependencies.delete_if do |d|
+ d.name == 'bones' and d.requirement.to_s =~ /^>=/
+end
View
13 tasks/bundler.rake
@@ -0,0 +1,13 @@
+namespace :bundle do
+
+ file 'Gemfile' => [ 'gem:spec' ] do
+ File.open( 'Gemfile', 'w+' ) do |f|
+ f.puts 'source "http://rubygems.org"'
+ f.puts 'gemspec'
+ end
+ end
+
+ desc "Create a bundler Gemfile"
+ task :gemfile => 'Gemfile'
+
+end
View
36 tasks/contribute.rake
@@ -0,0 +1,36 @@
+desc "Instructions on how to contribute to stickler"
+task :help do
+ abort <<-_banner
+-----------------------------------------------------------------------
+ I see you are wanting to do some development on stickler. You will
+ need to install the 'bones' gem first.
+
+ % gem install bones -v #{USING_BONES_VERSION}
+
+ The easiest way to start after that is with the
+ 'install:dependencies' task:
+
+ % rake install:dependencies
+
+ If you use bundler, then you will need to first create the Gemfile
+ and then run 'bundle install':
+
+ % rake bundle:gemfile
+ % bundle install
+
+ Now you are ready to work on stickler. Please submit bugs and pull
+ requests to:
+
+ https://github.com/copiousfreetime/stickler
+
+ Thanks!
+
+ -jeremy
+-----------------------------------------------------------------------
+_banner
+end
+
+desc "(Alias for 'help') Instructions on how to contribute to stickler"
+task 'how_to_contribute' => :help
+desc "(Alias for 'help') Instructions on how to contribute to stickler"
+task '==> I WANT TO CONTRIBUTE <==' => :help

0 comments on commit 8f09764

Please sign in to comment.