Update documentation

[linyanna]

Description

I made documentation changes that include clarifications to the README.md and CONTRIBUTING.md, adding a TODO.md to track issues and changes, and reorganization of files (screenshots and descriptions).

Type of change

Just put an x in the [] which are valid.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

• ./gradlew assembleDebug assembleRelease did not pass

What went wrong: Execution failed for task ':app:compileDebugJavaWithJavac'.
> superclass access check failed: class butterknife.compiler.ButterKnifeProcessor$RScanner (in unnamed module @0x3d036a7b) cannot access class com.sun.tools.javac.tree.TreeScanner (in module jdk.compiler) because module jdk.compiler does not export com.sun.tools.javac.tree to unnamed module @0x3d036a7b

• ./gradlew checkstyle passed after removing unrecognized jvm option "MaxPermSize=4096m"

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings

[codeclimate]

Code Climate has analyzed commit 3737de2 and detected 0 issues on this pull request.

View more on Code Climate.

[linyanna]

Further Details

I made documentation changes that include clarifications to the pull_request_template.md, README.md and CONTRIBUTING.md, adding a TODO.md to track issues and changes, and reorganization of files (screenshots and descriptions).

I added clarification to the pull_request_template.md, conveying that contributors should indicate the issue number they are fixing with the PR, if any, in order to close the issue when merged into the master branch.

I attempted to improve the clarity of the README.md file by moving the excess screenshots of the app's features to a folder directory I created, called "feature-documentation." I did this because the screenshots were more or less self-explanatory for both users and developers and cleared up clutter. I added to the empty "Contributing" section by redirecting to the CONTRIBUTING.md guidelines. I also moved the "Support Us" section to the bottom of the README.md.

For the CONTRIBUTING.md, I mainly added external links to documentation to help developers get started with Android Studio by understanding its modules, file view, and project structure, as well as to GitHub pull request, writing, and formatting guidelines.

I also added a TODO.md file that lists to do, in progress, and completed items. I'll admit that this might be a more redundant addition though, as the project seems to be decently keeping track of this with GitHub's own built-in issue tracker. A TODO.md would perhaps be more useful for a smaller project or a project still at the beginning of its development cycle.

[Swati4star]

Please take in the latest codebase. That should build the codebase and you shouldn't get error with gradlew.

Can you fix merge conflicts as well?

[Swati4star]

Can we skip adding this todo file? It's not exactly adding any value and would definitely not be maintained.

[Swati4star]

I would prefer to keep this section in README file. It helps people in understanding what exactly the project is.