Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (44 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

62 lines (44 loc) · 2.97 KB

Contributing to Mifos Gazelle Demo Runtime

First off, thank you for considering contributing to the Mifos Gazelle Demo Runtime! It's people like you that make the open-source community such a great place. We welcome any form of contribution, from reporting bugs and requesting features to submitting code changes.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open-source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

How Can I Contribute?

Reporting Bugs

This is one of the most helpful ways to contribute. If you find a bug, please ensure the bug was not already reported by searching on jira under gax-27.

If you're unable to find an open issue addressing the problem, open a new ticket. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

If you have an idea for an enhancement or a new feature, please open an issue to discuss it. This allows us to coordinate our efforts and prevent duplication of work.

When creating an enhancement suggestion, please:

  • Use a clear and descriptive title to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Explain why this enhancement would be useful to most users.

Pull Requests

The process described here has several goals:

  • Maintain project quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible solution
  • Enable a sustainable system for maintainers to review contributions

Development Workflow

  1. Fork the repo on GitHub.
  2. Clone your fork locally: 
    git clone [https://github.com/your_username/mifos-gazelle-demo-runtime.git](https://github.com/your_username/mifos-gazelle-demo-runtime.git)
  3. Create a feature branch for your local development: 
    git checkout -b name-of-your-bugfix-or-feature
    Now you can make your changes locally.
  4. Commit your changes using a descriptive commit message: 
    git commit -m "feat: Add some feature"
  5. Push your branch to your fork on GitHub: 
    git push origin name-of-your-bugfix-or-feature
  6. Open a Pull Request from your fork to the original main branch. Provide a clear title and description for your pull request, explaining the "what" and "why" of your changes.

Coding Standards

  • Follow the existing code style.
  • Write clear, commented code where necessary.
  • Ensure your code is readable and maintainable.

We look forward to your contributions!