CONTRIBUTING.md in forbes-finder-0.1.0 vs CONTRIBUTING.md in forbes-finder-0.1.1

- old
+ new

@@ -1,9 +1,23 @@ -## Creating an alias +# Contributing to Forbes Finder +## Creating aliases / subsidiaries + +Ebay is listed in the Forbes 2000, but it's domain is listed as `ebayinc.com`. In order for ForbesFinder to recognize `ebay.com` or `paypal.com` (both subsidiaries) we need to set up some alises. It's pretty easy to - just use git to store symlinks to the existing TOML files e.g. + ``` cd lib/data/2012 -ln -s microsoft.com.toml microsoft.co.uk.toml -git add microsoft.co.uk.toml -git commit -m "Add alias for microsoft.com" +ln -s ebayinc.com.toml ebay.com.toml +git add ebay.com.toml +git commit -m "Add alias for ebay.com" git push origin master -``` \ No newline at end of file +``` + +## General Guidelines + +* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet. +* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it. +* Fork the project. +* Start a feature/bugfix branch. +* Commit and push until you are happy with your contribution. +* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally. +* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.