Skip to content

Commit

Permalink
Update .github/CONTRIBUTING.md (openMF#250)
Browse files Browse the repository at this point in the history
  • Loading branch information
RajaVamsi11 authored and luckyman20 committed Jan 26, 2019
1 parent 67b9b51 commit 8d3d61f
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This guide details how to use issues and pull requests to improve Mobile Wallet

## Building Mobile Wallet Android Application.

There are two steps, you have to follow, when you are building the mobile-wallet android application.
There are two steps, you have to follow when you are building the mobile-wallet android application.

1. Setting up the [Android Studio](https://github.com/openMF/mobile-wallet/wiki/Android-Studio-setup)

Expand All @@ -14,25 +14,25 @@ There are two steps, you have to follow, when you are building the mobile-wallet

When a repository is cloned, it has a default remote called `origin` that points to your fork on GitHub, not the original repository it was forked from. To keep track of the original repository, you should add another remote named `upstream`:

The easiest way is to use the https url:
The easiest way is to use the https URL:

`git remote add upstream https://github.com/openMF/mobile-wallet.git`

or if you have ssh set up you can use that url instead:
or if you have ssh set up you can use that URL instead:

`git remote add upstream git@github.com:openMF/mobile-wallet.git`

## Commit Style Guide

Mifos Mobile Wallet Android application have set of [Commit Style Guidelines](https://github.com/openMF/mobile-wallet/wiki/Commit-style-guide). we strictly following this guideline to track the every change, any bug fixes, any enhancement and any new feature addition. we are suggesting you, please follow these guidelines to help us managing every commit.
Mifos Mobile Wallet Android application have a set of [Commit Style Guidelines](https://github.com/openMF/mobile-wallet/wiki/Commit-style-guide). We strictly follow this guideline to track every change, any bug fix, any enhancement, and any new feature addition. We are suggesting you to please follow these guidelines to help us managing every commit.

## Issue tracker

The [issue tracker](https://github.com/openMF/mobile-wallet/issues) is only for obvious bugs, misbehavior, & feature requests in the latest stable or development release of Self-Service Android Application. When submitting an issue please conform to the issue submission guidelines listed below. Not all issues will be addressed and your issue is more likely to be addressed if you submit a pull request which partially or fully addresses the issue.

### Issue tracker guidelines

**[Search](https://github.com/openMF/mobile-wallet/search?q=&ref=cmdform&type=Issues)** for similar entries before submitting your own, there's a good chance somebody else had the same issue or feature request. Show your support with `:+1:` and/or join the discussion. Please submit issues in the following format and feature requests in a similar format:
**[Search](https://github.com/openMF/mobile-wallet/search?q=&ref=cmdform&type=Issues)** for similar entries before submitting your own, there's a good chance somebody else had the same issue or feature request. Show your support with `+1:` and/or join the discussion. Please submit issues in the following format and feature requests in a similar format:

1. **Summary:** Summarize your issue in one sentence (what goes wrong, what did you expect to happen)
2. **Steps to reproduce:** How can we reproduce the issue?
Expand All @@ -53,17 +53,17 @@ If you can, please submit a pull request with the fix or improvements including
* Fork the project on GitHub
* Create a feature branch
* Write tests and code
* Run the CheckStyle, PMD, Findbugs code analysis tools with `gradlew check` to make sure you have written quality code.
* Run the CheckStyle, PMD, Findbugs code analysis tools with the `gradlew check` to make sure you have written quality code.
* If you have multiple commits please combine them into one commit by squashing them. See [this article](http://eli.thegreenplace.net/2014/02/19/squashing-github-pull-requests-into-a-single-commit) and [this Git documentation](http://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) for instructions.
* Please follow the commit message [guidelines](https://github.com/openMF/mobile-wallet/wiki/Commit-style-guide) before making PR.
* Push the commit to your fork
* Submit a pull request with a motive for your change and the method you used to achieve it with `development` branch.
* Submit a pull request with a motive for your change and the method you used to achieve it with the `development` branch.

We will accept pull requests if:

* It doesn't break any existing functionality
* It's quality code that conforms to standard style guides and best practices
* The description includes a motive for your change and the method you used to achieve it
* It is not a catch all pull request but rather fixes a specific issue or implements a specific feature
* It is not a catch-all pull request but rather fixes a specific issue or implements a specific feature
* If it makes changes to the UI the pull request should include screenshots
* It is a single commit (please use `git rebase -i` to squash commits)

0 comments on commit 8d3d61f

Please sign in to comment.