Skip to content

Latest commit

 

History

History
127 lines (93 loc) · 4.84 KB

README.md

File metadata and controls

127 lines (93 loc) · 4.84 KB
Raw

Chimoney SDK Challenge <> GDSC Covenant University

Logo


Table of Contents
  1. About The Project
    2. Getting Started
  2. Usage
  3. Contributing
  4. License
  5. Contact

About The Project

Welcome to the Chimoney <> GDSC Covenant University SDK Challenge, a collaborative initiative between Chimoney and the Google Developer Student Club (GDSC) at Covenant UNiversity. This challenge invites student developers to showcase their skills and creativity by developing SDKs for the Chimoney API. Currently the Chimoney API has Flutter, Python, PHP-Laravel, and Javascript SDKs. In order to enhance our documentation and make the integration with the Chimoney API easier for developers we need more SDKs in other languages such as Golang, Java, C#, and Dart.

About Chimoney

Chimoney is a revolutionary fintech company transforming the way businesses make bulk payments globally. With our platform businesses can streamline their payouts, reduce costs, and enhance their overall financial efficiency.

(back to top)

Getting Started

To get started you need to:

  1. Sign up for a Chimoney Developer Account:If you don't already have one, sign up for a Chimoney developer account sandbox access here
  • You can also check out this article on how to obtain API keys here.

  1. Create a New Application: Once logged in, navigate to your developer dashboard and create a new application. This will generate your API key for you.

  2. Start Contributing!

SDK Contribution Guide

As a contributor, kindly ensure your contribution follows the SDK Checklist:

✅ SDK Checklist

It is very important for us to maintain consistency in terms of structure and architecture for the SDKs. This checklist ensures we are able to accomplish this.

  • Proper Coding Standards and Conventions
  • Proper Skeleton Structure
  • Readme Doc (Demo,Installation Guide, Usage Examples)
  • Error Handling
  • Tests

See the open issues for a full list of proposed SDKs.

(back to top)

Submitting Your Contribution

  • If you want to work on any of the SDK issues then kindly ask to be assigned to it (we are able to assign multiple contributors at a time to an issue)
  • If you have a suggestion on an SDK you would like to build/to be built then create an issue on it.

Steps to Submitting your contribution

  1. Fork the Project
  2. Create your SDK-Feature Branch (git checkout -b SDK/SDK-Name)
  3. Commit your Changes to the SDK Submissions folder (git commit -m 'Added SDK-Name')
  4. Push to the Branch (git push origin SDK/SDK-Name)
  5. Open a Pull Request

Note: Replace SDK-Name with the actual name of the SDK

(back to top)

License

This project is licensed under the MIT License

Contact

For any questions or inquiries, please contact [email protected]