Skip to content

Latest commit

 

History

History
45 lines (37 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

45 lines (37 loc) · 1.44 KB
Raw

Contributing to ActiveShipping

We welcome fixes and additions to this project. Fork this project, make your changes and submit a pull request!

Code style

Please use clean, concise code that follows Ruby community standards. For example:

  • 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

Pull request guidelines

  • 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