Skip to content

Latest commit

 

History

History
73 lines (41 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

73 lines (41 loc) · 2.65 KB
Raw

Contributing to Mifos Gazelle

Thank you for your interest in contributing to the Mifos Gazelle repository! Your contributions are important and will help to improve the project for everyone. Before you begin, please consider the guidelines below.

Branches

  • Master - contains released versions of the Mifos Gazelle product
  • Dev - Where all contributions should be raised as PRs
  • ... - Individual branches used by contributors for pre-staging or testing

Please always contribute to Dev. We then compile accepted PRs from Dev into releases within the community and publish these every 3 months.

Getting Started

  • Make sure you have Git installed on your machine.
  • Fork the repository and clone it locally.

git clone --branch dev https://github.com/openMF/mifos-gazelle.git

  • Create a new branch for your contributions git checkout -b feature-branch-name

Making Changes

  • Before making changes, ensure that you're working on the latest version of the dev branch

git pull origin dev

Committing Changes

  • Stage your changes:

git add file-name(s)

  • Commit your changes with a descriptive message:

git commit -m "Add feature"

  • Push your changes to your forked repository:

git push origin feature-branch-name

Submitting a Pull Request

Code Review

  • After submitting your PR, our team will review your changes.
  • Address any feedback or requested changes promptly.
  • Once approved, your PR will be merged into the dev branch.
  • Every 3 months we will release from the 'dev' branch to the 'master' branch

Finding a Task

  • Check out the issues here
  • Join Mifos Slack
  • Subscribe to the #mifos-gazelle slack channel (used for support on release versions)
  • Request to join the Mifos-gazelle-dev slack channel
  • Have a look at the README.md and our other documentation in /docs/ Can it be improved? Do you see any typos? You may initiate a PR.

Reporting Issues

If you find any bugs or have recommendations for improvements, please feel free to open an issue with a detailed explanation of changes.

Contact

  • For further assistance or questions regarding contributions, feel free to join our Slack channel here

Thank you again for your interest in Mifos Gazelle! We look forward to your contributions.