Skip to content

Commit

Permalink
merged dev to master in prep for release , inc new LICENSE file
Browse files Browse the repository at this point in the history
  • Loading branch information
tdaly61 committed Dec 16, 2024
2 parents 2eed147 + ee2ca18 commit e93ae1b
Show file tree
Hide file tree
Showing 43 changed files with 14,680 additions and 1,338 deletions.
21 changes: 20 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,28 @@ cython_debug/

#Helm
charts/
Chart.lock

#gitrepos
vnext/
mojaloop/
ph/
fineract/
apps/
apps/
repos/

# OS generated files #
######################
.DS_Store
.settings
.Spotlight-V100
.Trashes
.terraform
ehthumbs.db
Thumbs.db
.project
.cproject
.pydevproject
.idea
*.swp
sds_*
21 changes: 21 additions & 0 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Mifos Gazelle Architecture

Mifos Gazelle is primarily a deployment tool it allows for deployment of multiple DPGs. This architecture document outlines the architecture of Mifos Gazelle it does not outline the architecture of the DPGs it deploys you should refer to their architecture documentation for this.


## Dependencies



## DPGs deployable

- MifosX vx.x.x. including Apache Fineract vx.x.x
- Payment Hub Enterprise Edition (PHEE) v1.13.0
- Mojaloop vNext Beta1


## Languages and modules used



This architecture document is currently a work in progress
75 changes: 40 additions & 35 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
---
# 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.

Thank you for your interest in contributing to the Mojafos 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](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed on your machine.
- Fork the repository and clone it locally.

```
git clone https://github.com/openMF/mojafos.git
```


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


- Create a new branch for your contributions

```
git checkout -b feature-branch-name
```
git checkout -b feature-branch-name


## Making Changes

- Before making changes, ensure that you're working on the latest version of the `master` branch

```
git pull origin master
```
- 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)
```

git add file-name(s)

- Commit your changes with a descriptive message:

```
git commit -m "Add feature"
```

git commit -m "Add feature"

- Push your changes to your forked repository:

```
git push origin feature-branch-name
```

git push origin feature-branch-name


## Submitting a Pull Request

Expand All @@ -51,18 +51,23 @@ Thank you for your interest in contributing to the Mojafos repository! Your cont

- 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 `master` branch.
- 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](https://github.com/openMF/mojafos/issues)
- Have a look at the README.md Can it be improved? Do you see any typos? You may initiate a PR.

- Check out the issues [here](https://github.com/openMF/mifos-gazelle/issues)
- 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](https://github.com/openMF/mojafos/issues) with a detailed explanation of changes.

If you find any bugs or have recommendations for improvements, please feel free to [open an issue](https://github.com/openMF/mifos-gazelle/issues) with a detailed explanation of changes.

## Contact
- For further assistance or questions regarding contributions, feel free to join our Slack channel [here](https://mifos.slack.com/ssb/redirect)

Thank you for contributing to [Mojafos](https://github.com/openMF/mojafos)! We look forward to your contributions.
- For further assistance or questions regarding contributions, feel free to join our Slack channel [here](https://mifos.slack.com/ssb/redirect)

---
Thank you again for your interest in [Mifos Gazelle](https://github.com/openMF/mifos-gazelle)! We look forward to your contributions.
Loading

0 comments on commit e93ae1b

Please sign in to comment.