[GitHub] therajanmaurya closed pull request #2: docs: update readme
therajanmaurya closed pull request #2: docs: update readme
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/COMMIT_STYLE.md b/COMMIT_STYLE.md
new file mode 100644
@@ -0,0 +1,42 @@
+# Git Commit Message Style Guide
+## Commit Messages
+### Message Structure
+A commit messages consists of three distinct parts separated by a blank line: the title, an optional body and an optional footer. The layout looks like this:
+The title consists of the type of the message and subject.
+### The Type
+The type is contained within the title and can be one of these types:
+* **feat:** a new feature
+* **fix:** a bug fix
+* **docs:** changes to documentation
+* **style:** formatting, missing semi colons, etc; no code change
+* **refactor:** refactoring production code
+* **test:** adding tests, refactoring test; no production code change
+* **chore:** updating build tasks, package manager configs, etc; no production code change
+### The Subject
+Subjects should be no greater than 50 characters, should begin with a capital letter and do not end with a period.
+Use an imperative tone to describe what a commit does, rather than what it did. For example, use change; not changed or changes.
+### The Body
+Not all commits are complex enough to warrant a body, therefore it is optional and only used when a commit requires a bit of explanation and context. Use the body to explain the what and why of a commit, not the how.
+When writing a body, the blank line between the title and the body is required and you should limit the length of each line to no more than 72 characters.
+### The Footer
+The footer is optional and is used to reference issue tracker IDs.
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
@@ -0,0 +1,72 @@
+# Contribute to Apache Fineract CN Android Client
+This guide details how to use issues and pull requests to improve Apache Fineract CN Android Client.
+## Configure remotes
+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:
+`git remote add upstream https://github.com/apache/fineract-cn-mobile.git`
+or if you have ssh set up you can use that url instead:
+`git remote add upstream git@xxxxxxxxxx:apache/fineract-cn-mobile.git`
+### Issue tracker guidelines
+**[Search](https://github.com/apache/fineract-cn-mobile/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?
+3. **Expected behavior:** What did you expect the app to do?
+4. **Observed behavior:** What did you see instead? Describe your issue in detail here.
+5. **Device and Android version:** What make and model device (e.g., Samsung Galaxy S3) did you encounter this on? What Android version (e.g., Android 4.0 Ice Cream Sandwich) are you running? Is it the stock version from the manufacturer or a custom ROM?
+5. **Screenshots:** Can be created by pressing the Volume Down and Power Button at the same time on Android 4.0 and higher.
+6. **Possible fixes**: If you can, link to the line of code that might be responsible for the problem.
+## Pull requests
+We welcome pull requests with fixes and improvements to Self-Service Android Application code, tests, and/or documentation. The features we would really like a pull request for are [open issues with the enhancements label](https://github.com/openMF/self-service-app/issues?labels=enhancement&page=1&state=open).
+### Pull request guidelines
+If you can, please submit a pull request with the fix or improvements including tests.
+* 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.
+* 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/apache/fineract-cn-mobile/COMMIT_STYLE.md) 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.
+We will accept pull requests if:
+* The code has proper tests and all tests pass (or it is a test exposing a failure in existing code)
+* 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
+* 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)
+### Best Practices for reporting or requesting for Issues/Enhancements:
+ - Follow the Issue Template while creating the issue.
+ - Include Screenshots if any (specially for UI related issues)
+ - For UI enhancements or workflows, include mockups to get a clear idea.
+### Best Practices for assigning an issue:
+- If you would like to work on an issue, inform in the issue ticket by commenting on it.
+- Please be sure that you are able to reproduce the issue, before working on it. If not, please ask for clarification by commenting or asking the issue creator.
+Note: Please do not work on issues which is already being worked on by another contributor. We don't encourage creating multiple pull requests for the same issue. Also, please allow the assigned person some days to work on the issue ( The time might vary depending on the difficulty). If there is no progress after the deadline, please comment on the issue asking the contributor whether he/she is still working on it. If there is no reply, then feel free to work on the issue.
+### Best Practices to send Pull Requests:
+ - Follow the Pull request template.
+ - Commit messages should follow this template: `Fix #<issue-no> - <issue-desc>`
+ - Squash all your commits to a single commit.
+ - Create new branch before adding and commiting your changes ( This allows you to send multiple Pull Requests )
\ No newline at end of file
diff --git a/README.md b/README.md
index 8111ac2..c53572b 100644
@@ -4,9 +4,28 @@
# Android Client of Apache Fineract CN
-This is an Android Application built on top of the Apache Fineract CN platform. This is a native Android Application written purely in Java.
+Android Client is built on top of the Apache Fineract CN platform.
+## Building the Project
+1. Install [Java Development Kit (JDK)](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+2. Download, install, and run the latest version of [Android Studio](http://developer.android.com/sdk/installing/studio.html).
+3. Clone this repository and import it to Android Studio.
+4. Once the gradle build is finished, click on the green play button to build and run the app.
+### Demo Credentials
+You can use these credentials to log in.
+We love Pull Requests, Bug Reports, ideas, code reviews or any other kind of positive contribution.
+- [Current issues](https://issues.apache.org/jira/browse/FINCN-13?jql=project%20%3D%20FINCN%20AND%20component%20%3D%20fineract-cn-mobile)
+- [Pull requests](https://github.com/apache/fineract-cn-mobile/pulls)
+### Commit Style Guide
+ We have set of [Commit Style Guidelines](https://github.com/apache/fineract-cn-mobile/COMMIT_STYLE.md) and [Contribution Guidelines](https://github.com/apache/fineract-cn-mobile/CONTRIBUTING.md). We follow these guideline to track the every change, any bug fixes, any enhancement and any new feature addition. We also suggest you to follow these guidelines to help us manage every commit.
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
Apache Git Services