CONTRIBUTING.md in active_shipping-1.8.6 vs CONTRIBUTING.md in active_shipping-1.9.0

- old
+ new

@@ -1,45 +1,21 @@ # Contributing to ActiveShipping -We welcome fixes and additions to this project. Fork this project, make your changes and submit a pull request! +We love receiving pull requests! Anything from new carriers to documentation fixes. -### Code style +## Standards -Please use clean, concise code that follows Ruby community standards. For example: +* PR should explain what the feature does, and why the change exists. +* PR should include any carrier specific documentation explaining how it works. +* Code _must_ be tested, including both unit and remote tests where applicable. +* Be consistent. Write clean code that follows [Ruby community standards](https://github.com/bbatsov/ruby-style-guide). +* Code should be generic and reusable. -- Be consistent -- Don't use too much white space - - Use 2 space indent, no tabs. - - No spaces after `(`, `[` and before `]`, `)` -- Nor too little - - Use spaces around operators and after commas, colons and semicolons - - Indent when as deep as case -- Write lucid code in lieu of adding comments +If you're stuck, ask questions! -### Pull request guidelines +## How to contribute -- Add unit tests, and remote tests to make sure we won't introduce regressions to your code later on. -- Make sure CI passes for all Ruby versions and dependency versions we support. -- XML handling: use `Nokogiri.XML` for parsing XML, and `Nokogiri::XML::Builder` to generate it. -- JSON: use the JSON module that is included in Rubys standard ibrary -- HTTP: use `ActiveUtils`'s `PostsData`. -- Do not add new gem dependencies. - -### Contributors - -- James MacAulay (<http://jmacaulay.net>) -- Tobias Luetke (<http://blog.leetsoft.com>) -- Cody Fauser (<http://codyfauser.com>) -- Jimmy Baker (<http://jimmyville.com/>) -- William Lang (<http://williamlang.net/>) -- Cameron Fowler -- Christopher Saunders (<http://christophersaunders.ca>) -- Denis Odorcic -- Dennis O'Connor -- Dennis Theisen -- Edward Ocampo-Gooding -- Isaac Kearse -- John Duff -- Nigel Ramsay -- Philip Arndt -- Vikram Oberoi -- Willem van Bergen +1. Fork it ( https://github.com/Shopify/active_shipping/fork ) +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create a new Pull Request