Skip to main content
Version: 1.0

Contribution Guidelines

Namaste, Rahat development team would like to thank you for taking the time to contribute! We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer
  • Getting involved with Rahat community

We have created guidelines for contributing to Rahat project and packages. These are guidelines, not rules. We encourage you to use your best judgment, and feel free to recommend changes to this document in a pull request. We use github to host code, to track issues and feature requests, as well as accept pull requests.

How to contribute to the Rahat Project?

This section guides you through submitting a bug report for Rahat. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports You can submit a bug report or any suggestions on this project through github issues. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster. The best way to contribute to this project is by making a pull request in following ways

  • Fork the Rahat project and work on your fork
  • Create a new branch on which you want to make changes - “git checkout -b ‘my-contribution’ ” or push your changes on develop branch
  • Please make one pull request per issue to avoid large merges.
  • Commit your change with a commit message describing the correction.
  • Submit a pull request against the Rahat repository. In general, all pull requests must:
  • Have a clear use case, fix a demonstrable bug or serve the greater good of the project
  • Have unit tests, functional tests, and fuzz tests, where appropriate;
  • Follow code style guidelines
  • Not break the existing test suite;
  • Where bugs are fixed, where possible, there should be unit tests demonstrating the bug and also proving the fix. This helps prevent regression.
  • Change relevant comments and documentation when the behavior of code changes.

Contributing with an issue

If you find any bug and you're not sure how to fix it, or you don't know how to do a pull request, then you can create an Issue. Filing an Issue will help us see the problem and fix it. Issues in Rahat’s Github repositories are the primary means by which bug reports, feedback, and general discussions are made. A contributor is invited to create an issue, discuss it, and provide a fix if needed.

Reporting Bugs

This section guides you through submitting a bug report for Rahat. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎. Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information.

Contribute beyond coding...

You can share your skills and insights to support the Rahat community grow .

For Feedbacks and Insights

If you have expertise and experience in cash transfer and want to share your insights and feedback with the community at [email protected] or connect with us [t] [d]

For Documentation

We share our journey - and the lessons we learned on the way through reports, case studies, articles, blogs, and surveys. Contact us if you want to contribute and learn more 👉 [email protected] or connect with us [t] [d]

For Designs

If you are interested in creating and designing in UI/UX, animations, photos, infographics, IEC materials, tutorials, and explainers for the Rahat community -- feel free to contact us with any design-related questions 👉 [email protected]or connect with us [t] [d]

Style Guide

This repository uses eslint to enforce air-bnb coding styles.

Connect with Rahat Contributors

If you want to connect with our contributors, you can connect us at Join the chat at https://gitter.im/bockies/community

Last updated : 11/15/2021