Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 46.5 KiB
Newer Older
  • Learn to ignore specific revisions
    • Alex Reisner's avatar
    Convert README from Rdoc to Markdown.
    Alex Reisner committed
    1001 1002
    Alex Reisner's avatar
    Add section on Contributing.  
    Alex Reisner committed
    1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 
    Contributing
------------

Contributions are welcome via pull requests on Github. Please respect the following guidelines:

* Each pull request should implement ONE feature or bugfix. If you want to add or fix more than one thing, submit more than one pull request.
* Do not commit changes to files that are irrelevant to your feature or bugfix (eg: `.gitignore`).
* Do not add dependencies on other gems.
* Do not add unnecessary `require` statements which could cause LoadErrors on certain systems.
* Remember: Geocoder needs to run outside of Rails. Don't assume things like ActiveSupport are available.
    Alex Reisner's avatar
    Fix typo.  
    Alex Reisner committed
    1013 
    * Do not add to base configuration options; instead document required lookup-specific options in the README.
    Alex Reisner's avatar
    Add section on Contributing.  
    Alex Reisner committed
    1014 1015 1016 1017 
    * Be willing to accept criticism and work on improving your code; Geocoder is used by thousands of developers and care must be taken not to introduce bugs.
* Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request.
    Alex Reisner's avatar
    Convert README from Rdoc to Markdown.
    Alex Reisner committed
    1018 
    Copyright (c) 2009-12 Alex Reisner, released under the MIT license
    Show full blame