Skip to content

Commit

Permalink
Merge pull request #34 from openMF/tomdev5
Browse files Browse the repository at this point in the history
tidying in preparation for release (#2)
  • Loading branch information
tdaly61 authored Dec 16, 2024
2 parents 2979224 + cf51616 commit ee2ca18
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 37 deletions.
2 changes: 1 addition & 1 deletion ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Mifos Gazelle is primarily a deployment tool it allows for deployment of multipl

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


## Languages and modules used
Expand Down
63 changes: 28 additions & 35 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,47 @@
---

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.
# 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
* 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.
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 --branch dev https://github.com/openMF/mifos-gazelle.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 `dev` branch

```
git pull origin dev
```

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 @@ -63,18 +55,19 @@ Please always contribute to Dev we then compile accepted PRs from Dev into relea
- 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/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/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 [Mifos Gazelle](https://github.com/openMF/mifos-gazelle)! 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.
2 changes: 1 addition & 1 deletion src/utils/install-k9s.sh
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ tar -xzf "$tmp_dir/k9s.tar.gz" -C "$tmp_dir"

# Move k9s to the user's bin directory (assuming it's named k9s after extraction)
mkdir -p "$HOME/local/bin"
mv "$tmp_dir/k9s" "$HOME/bin/k9s"
mv "$tmp_dir/k9s" "$HOME/local/bin/k9s"

# Echo the path to add to bashrc
echo "To use k9s, add the following line to your .bashrc:"
Expand Down

0 comments on commit ee2ca18

Please sign in to comment.