Guidelines for contributors

Contribute to Voice Calculator Android Application

This guide details how to use issues and pull requests to improve Voice Calculator Android Application.

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/mayank-kgp/VoiceCalculator.git

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

git remote add upstream [email protected]:mayank-kgp/VoiceCalculator.git

Issue tracker

The issue tracker is only for obvious bugs, misbehavior, & feature requests in the latest stable or development release of VoiceCalculator 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 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?
6. Screenshots: Can be created by pressing the Volume Down and Power Button at the same time on Android 4.0 and higher.
7. 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 VoiceCalculator Android Application code, tests, and/or documentation.

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 and this Git documentation for instructions.
• Please follow the commit message guidelines 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)