Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 2.03 KB

Contributing guidelines

We gladly accept bugfixes and new gateways. Please follow the guidelines here to ensure your work is accepted.

New Gateways

Please see the ActiveMerchant Guide to Contributing a new Gateway for information on adding a new gateway to ActiveMerchant.

Issues & Bugfixes

Reporting issues

When filing a new Issue:

  • Please make clear in the subject what gateway the issue is about.
  • Include the version of ActiveMerchant, Ruby, ActiveSupport, and Nokogiri you are using.

Pull request guidelines

When submitting a pull request to resolve an issue:

  1. Fork it and clone your new repo
  2. Create a branch (git checkout -b my_awesome_feature)
  3. Commit your changes (git add my/awesome/file.rb; git commit -m "Added my awesome feature")
  4. Push your changes to your fork (git push origin my_awesome_feature)
  5. Open a Pull Request

Gateway Placement within Shopify

The addition of your gateway to active_merchant does not guarantee placement within Shopify. In order to have your gateway considered, please send an email to [email protected] with Active_Merchant Integration in the subject. Be sure to include:

  1. Name, URL & description of the payment provider you wish to integrate
  2. Markets served by this integration
  3. List of major supported payment methods
  4. Your most recent Certificate of PCI Compliance

Version/Release Management

Contributors don't need to worry about versions, this is something Committers do at important milestones:

  1. Check the semantic versioning page for info on how to version the new release.
  2. Update the ActiveMerchant::VERSION constant in lib/active_merchant/version.rb.
  3. Add a CHANGELOG entry for the new release with the date
  4. Tag the release commit on GitHub: bundle exec rake tag_release
  5. Release the gem to rubygems using ShipIt