Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme file #1806

Closed
wants to merge 9 commits into from
Closed

Update readme file #1806

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2f0d876
update readme file with branch Policy
kapmaurya Oct 30, 2024
34d7c6c
update readme file with branch Policy
kapmaurya Oct 30, 2024
8a9c37a
update readme file with Demo Credentials
kapmaurya Oct 30, 2024
f5dc15f
update readme file with Development Setup
kapmaurya Oct 30, 2024
0e37011
update readme file with committing your changes
kapmaurya Oct 30, 2024
a6dbcb7
update readme file with committing your changes
kapmaurya Nov 1, 2024
eb5d02e
update readme file with Making Pull Request
kapmaurya Nov 1, 2024
dd46ba7
update readme file with Squashing your Commits
kapmaurya Nov 1, 2024
f428b6b
update readme file with Solving Merge Conflicts
kapmaurya Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
211 changes: 17 additions & 194 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,200 +24,23 @@ Mifos boasts an active and vibrant contributor community, Please join us on [sla

### [How to Contribute](https://github.com/openMF/mobile-wallet/wiki/How-to-Contribute)

### Branch Policy


We have the following branches :

* **dev**
All the contributions should be pushed to this branch. If you're making a contribution,
you are supposed to make a pull request to _dev_.
Please make sure it passes a build check on Travis.

It is advisable to clone only the development branch using the following command:

```
git clone -b <branch> <remote_repo>
```

With Git 1.7.10 and later, add --single-branch to prevent fetching of all branches. Example, with development branch:

```
git clone -b dev --single-branch https://github.com/username/mobile-wallet.git`
```

* **master**
The master branch contains all the stable and bug-free working code. The development branch once complete will be merged with this branch.

### Demo credentials
Fineract Instance: demo.mifos.io

Username: `venus`

Password: `Venus2023#`

### Development Setup

Before you begin, you should have already downloaded the Android Studio SDK and set it up correctly. You can find a guide on how to do this here: [Setting up Android Studio](http://developer.android.com/sdk/installing/index.html?pkg=studio).

1. **Fork the Git Repository**

Forking the repository is the first step to start contributing. Click on the "Fork" button in the top right corner of the **[Mobile Wallet (Mifos Pay) repository](https://github.com/openMF/mobile-wallet)** to create your own fork.

![image](https://user-images.githubusercontent.com/44428198/254533248-3016c6eb-30b7-492b-91e8-dbbb61f76775.png)

Forking creates a copy of the project under your GitHub account. This enables you to work on changes without affecting the original repository directly.

2. **Clone the Forked Repository**

Once you have forked the repository, you need to clone it to your local development environment. Open a terminal or Git Bash and use the following command:

```bash
git clone https://github.com/yourUsername/mobile-wallet.git
```

Replace **`yourUsername`** with your actual GitHub username. Cloning creates a local copy of the repository on your machine, allowing you to make changes and contributions.

3. **Working Locally on Your Cloned Repository**

After cloning, navigate to the project directory using the terminal or Git Bash.

Before making any changes, create a new branch dedicated to the feature or bug fix you'll be working on:

```bash
git checkout -b "new-branch-name"
```

Ensure that **`new-branch-name`** reflects the purpose of your changes (e.g., **`add-payment-feature`** or **`fix-bug-123`**).

Make the necessary changes to the files to address the issue you're working on. Once you're done, you will be ready to proceed with verifying and committing your changes.

4. **Perform a Gradle Check**

All your pull requests must pass the CI build only then, it will be allowed to merge.
Sometimes, when the build doesn't pass you can use these commands in your local terminal and check for the errors,</br>

**We've commited to use Material3 design in our project. And added lint check for not to use any M2 libraries in our project.</br>**
**And when adding new library, please make sure to follow the naming convention and place in sequential order(A->Z).</br>**

In MacOS, Windows or Linux, you should run the following commands before opening a PR, and make sure to pass all the commands:

**In order to enhance our development process, we have implemented Git hooks in our project.
To install these hooks locally, simply run the command `./gradlew installGitHooks`.
This will ensure that the Git hooks are installed on your local machine.**</br>

* `./gradlew check -p build-logic` this checks build-logic configured properly.</br>
* `./gradlew spotlessApply --no-configuration-cache` an check and apply formatting to any file.</br>
* `./gradlew dependencyGuardBaseline` to generate dependency-guard baseline.</br>
* `./gradlew detekt` to check detekt error.</br>
* `./gradlew testDemoDebug :lint:test :mifospay:lintProdRelease :lint:lint` to check lint and test error.</br>
* `./gradlew build` to build the project.</br>
* `./gradlew updateProdReleaseBadging` to update the badging for the project.</br>

*Or Run the `ci-prebuild.sh` or `ci-prebuild.bat` script to run all the above commands in one go.*

### **Committing Your Changes**

When you've finished making your changes and have tested them locally, it's time to commit your work:

1. **Stage Changes**

Use the following command to stage all changes:

```bash
git add .
```

This adds all modified and new files to the staging area, preparing them for the commit.

2. **Commit Changes**

Commit your changes with a meaningful commit message that describes the purpose of your changes:

```bash
git commit -m "Your commit message goes here"
```

A good commit message is concise and provides enough context about the changes made. Mifos follows its own commit style guidelines that you must follow. Learn more about it [here](https://github.com/openMF/mifos-mobile-cn/blob/master/COMMIT_STYLE.md).

3. **Push Changes**

Push your changes to your forked repository on GitHub:

```bash
git push origin new-branch-name
```

Replace **`new-branch-name`** with the name of the branch you created earlier.

### **Making a Pull Request**

Once your changes are pushed to your forked repository, you can initiate a pull request to merge your changes into the main project:

1. Navigate to the [Mobile Wallet (Mifos Pay) repository](https://github.com/openMF/mobile-wallet) on GitHub.
2. Click on the "Pull Requests" tab and then click "New Pull Request."

![image](https://user-images.githubusercontent.com/44428198/254533309-2df4dca7-aec3-4197-8b86-8b80988e08d7.png)

1. Ensure the base repository is set to "openMF/mobile-wallet" and the base branch is the main development branch `dev`.
2. Set the compare repository to your forked repository and the compare branch to the branch you just created with your changes (e.g., in my case, the head repository was set to “rchtgpt/mobile-wallet” and the comparison branch was `kotlin-migration-common`.
3. Fill out the pull request template, providing a clear description of your changes, why they are necessary, and any relevant information for the reviewers.
4. Click "Create Pull Request" to submit your changes for review.

### **Squashing Your Commits**

It is common for pull requests to undergo multiple rounds of review before being merged. To keep the Git history clean and organized, you should always squash your commits before finalizing the merge. Here's how you can do it:

1. Squash your commits:

```bash
git rebase -i HEAD~x
```

Replace **`x`** with the number of commits you want to squash. An interactive rebase will open, allowing you to choose how to combine the commits. Change **`pick`** to **`squash`** (or simply **`s`**) for all but the topmost commit. Save and exit the editor.

2. Amend the commit message if needed.

```bash
git commit --amend
```

3. Force push the changes to your forked repository:

```bash
git push --force origin your-branch-name
```

Please note that force pushing rewrites the Git history, so use it with caution.


### **Solving Merge Conflicts**

In some cases, your pull request might encounter merge conflicts when the changes cannot be automatically merged with the main branch. To resolve merge conflicts:

1. Update your local branch with the latest changes from the main repository:

```bash
git fetch upstream
git checkout your-branch-name
git rebase upstream/master
```

2. Git will pause when encountering conflicts. Open the affected files, resolve the conflicts manually, and save the changes.
3. After resolving all conflicts, stage the changes and continue with the rebase:

```bash
git add .
git rebase --continue
```

4. Finally, force push the changes to your forked repository:

```
git push --force origin your-branch-name
```

Your pull request will be updated with the resolved conflicts, and the reviewers can proceed with the review process. Again, don’t forget to squash your commits.
### [Branch Policy](https://github.com/openMF/mobile-wallet/wiki/Branch-Policy)

### [Demo credentials](https://github.com/openMF/mobile-wallet/wiki/Demo-credentials)

### [Development Setup](https://github.com/openMF/mobile-wallet/wiki/Development-Setup)


### [Committing Your Changes](https://github.com/openMF/mobile-wallet/wiki/Committing-Your-Changes)


### [**Making a Pull Request**](https://github.com/openMF/mobile-wallet/wiki/Making-a-Pull-Request)


### [**Squashing Your Commits**](https://github.com/openMF/mobile-wallet/wiki/Squashing-Your-Commits)


### [**Solving Merge Conflicts**](https://github.com/openMF/mobile-wallet/wiki/Solving-Merge-Conflicts)

### Conclusion
By following these contribution guidelines, you're all set to start contributing to the Mobile Wallet (Mifos Pay) project. We appreciate your efforts and look forward to your valuable contributions. Happy coding!
Expand Down
Loading