Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 3.77 KB

contribute.md

File metadata and controls

53 lines (34 loc) · 3.77 KB
Raw

What is this?

We're sharing code to help create interoperable payments platforms that can be deployed on a national scale. The idea is to make it easier for financial providers to deliver digital financial services to new customers in new markets, especially in the developing world. See our README.md for an overview, or visit mojaloop.io for context and information.

How do I contribute?

Local Development Setup

Steps to setup your local enviroment to contibute to the Mojaloop project:

  1. Central Ledger Setup: To setup the Mojaloop Central Ledger on your local machine follow the instructions detailed in the onboarding.md.

  2. Kubernetes Setup: To setup Kubernetes to run the Central Ledger follow the setup instructions detailed in the kubernetes.md.

  3. Helm Setup: To setup Helm charts to streamlines the installation and management of Kubernetes applications follow the setup instructions detailed in the Helm readme.md

What work is needed?

Work is tracked as issues in GitHub. You'll see issues there that are open and marked as bugs, stories, or epics. An epic is larger work that contains multiple stories. Anything that is in the backlog and not assigned to someone are things we could use help with. Stories that have owners are in someone's backlog already, though you can always ask about them in the issue or on Slack.

There's a roadmap that shows larger work that people could do or are working on. It has some main initiatives and epics and the order, but lacks dates as this work is community driven. Work is broken down from there into issues in GitHub.

In general, we are looking for example implementations and bug fixes, and project enhancements.

Where do I get help?

Join the Mojaloop #General Channel to connect with other developers.

Also checkout the FAQ

Where to I send bugs, questions, and feedback?

For bugs, see Reporting bugs.

Pull Request Process

It's a good idea to ask about major changes on Slack. Submit pull requests which include both the change and the reason for the change. Pull requests will be denied if they violate the Level One Principles

Style guides and templates

Code of conduct

We use a standard developer code of conduct

Licensing

See License policy

What version?

Naturally, we use semantic versioning, and each repo has it's own version. Update the version appropriately when you submit a pull request.

Example: git tag v0.4.0 # update the version.

Additional Information

For additional information please review the frequently asked questions.