Update documentation

.github/pull_request_template.md

@@ -3,11 +3,12 @@
 Please include a summary of the change and which issue is fixed. List any dependencies that are required for this change.
 If there are any UI change, please include the screenshots also.
 
-Fixes #(issue)
+If an issue has been fixed, please indicate with issue number using the following format:
+Fixes #ISSUE NUMBER
 
 ## Type of change
 Just put an x in the [] which are valid.
-- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] Bug fix (non-breaking change which fixes an issue, with included issue number in description)
 - [ ] New feature (non-breaking change which adds functionality)
 
 # How Has This Been Tested?

CONTRIBUTING.md

@@ -1,15 +1,15 @@
 # Contributing
 
 When contributing to this repository, please first discuss the change you wish to 
-make via issue, email (swati4star@gmail.com) , or any other method with the owners 
+make via issue, email (swati4star@gmail.com), or any other method with the owners 
 of this repository before making a change. 
 
 ## Pull Request Process
 
 ### 1. Explore
 
-If there is some issue or bug, you are interested in and no one else is working 
-on the issue, you may take it up ( just leave a comment on the issue).
+Here is our [To Do](TODO.md) list with to do, in progress, and completed issues. If there is some issue or bug you are interested in, and no one else is working 
+on the issue, you may take it up (just leave a comment on the issue page and update the to do list when you submit your pull request).
 
 ### 2. Fork & create a branch
 
@@ -25,7 +25,7 @@ git checkout -b 13-add-xyz-feature
 ### 3. Build & run the project locally
 
 [Import the project](https://developer.android.com/studio/projects/create-project.html#ImportAProject) in Android Studio. 
-Build it & run the project on emulator / real device.
+Build it & run the project on emulator / real device. If you're new to Android Studio, we recommend checking out their [Projects Overview](https://developer.android.com/studio/projects), as it gives a great overview of what you need to know about modules, and file view and project structure.
 
 
 ### 4. Implement your fix or feature
@@ -64,7 +64,7 @@ git rebase master
 git push --set-upstream origin 13-add-xyz-feature
 ```
 
-Finally, go to GitHub and [make a Pull Request][] :D
+Finally, go to GitHub and [make a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests):D. Be sure to follow the pull request template provided. [Here's] (https://docs.github.com/en/get-started/writing-on-github) a guide to writing and formatting on GitHub, if you'd like extra tips or want to be fancy.
 
 Travis CI and Circle CI will run our test suite. We care about quality, so 
 your PR won't be merged until all tests pass. 

README.md

@@ -12,11 +12,7 @@
 Have JPG when you need a PDF? Convert JPG to PDF in a few seconds! :smiley:  
 Here is an easy to use Android app to convert images to PDF file!
 
-<img src="./screenshots/image_to_pdf2.gif"  width="300px">
-
-
-### Support Us
-<a href="https://www.buymeacoffee.com/qITGMWB" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
+<img src="./feature-documentation/screenshots/image_to_pdf2.gif"  width="300px">
 
 
 ### Features 
@@ -40,50 +36,15 @@ Here is an easy to use Android app to convert images to PDF file!
 
 Here is a home page to get quick access to all the features "PDF Converter" provides:
 
-<img src="./screenshots/0_1_home.png" width="190px"> <img src="./screenshots/0_2_home.png" width="190px">
-
-### Creating a PDF file
-
-##### Step 1 : User can view the PDF files previously created or create a new one! 
-<img src="./screenshots/1_home.png" width="190px">
-
-
-##### Step 2 : Select the images
-<img src="./screenshots/2_1_camera.png" width="190px"> <img src="./screenshots/2_gallery.png" width="190px">
-
-
-##### Step 3 : Name the PDF file
-<img src="./screenshots/3_rename.png" width="190px">
-
-
-##### Step 4 : Creating PDF
-<img src="./screenshots/4_converting.png" width="190px">
-
-
-Hurray! PDF files of selected images are created.
+<img src="./feature-documentation/screenshots/0_1_home.png" width="190px"> <img src="./feature-documentation/screenshots/0_2_home.png" width="190px">
 
 
-### Viewing the PDF files
-
-<img src="./screenshots/5_viewfiles.png" width="190px"> <img src="./screenshots/6_viewfiles_Action.png" width="190px">
-
-### Different themes
-Go to Settings, and you can have three type of themes : Black, Dark and White
-
-Black | Dark | White |
---- | --- | --- |
-<img src="./screenshots/home_theme_black.png" width="190px"> | <img src="./screenshots/home_theme_dark.png" width="190px"> |  <img src="./screenshots/home_theme_white.png" width="190px"> |
-
-### Merge PDF
-<img src="./screenshots/7_merge_pdf.png" width="190px">
-
-### Text to PDF
-<img src="./screenshots/8_text_to_pdf.png" width="190px">
-
-### History
-<img src="./screenshots/9_history.png" width="190px">
-
 ### Contributing
+If you are a developer and you wish to contribute to the app please fork the project, create a branch, 
+and submit a pull request. Please refer to and adhere to our [contribution guidelines for this project](CONTRIBUTING.md). Here is our [To Do](TODO.md) list with to do, in progress, and completed issues.
+
+Follow [Github Flow](https://help.github.com/articles/github-flow/) for collaboration!
+If you have any questions, feel free to ask [me](mailto:swati4star@gmail.com) about whatever you want.
 
 #### Dependencies
 + [Butterknife](https://jakewharton.github.io/butterknife/)
@@ -101,13 +62,9 @@ Black | Dark | White |
 + [viewpager-transformers](https://github.com/geftimov/android-viewpager-transformers)
 + [zxing](https://github.com/zxing/zxing)
 
-#### Code & Issues
-If you are a developer and you wish to contribute to the app please fork the project
-and submit a pull request.
-Follow [Github Flow](https://help.github.com/articles/github-flow/) for collaboration!
-If you have any questions, feel free to ask [me](mailto:swati4star@gmail.com) about whatever you want.
-[Here](https://github.com/Swati4star/Images-to-PDF/issues) is the list of known issues.
 
 ### Project Maintainers
 This project is founded and actively maintained by [Swati Garg](https://github.com/Swati4star/). For any sort of queries feel free to mail at swati4star@gmail.com.
 
+### Support Us
+<a href="https://www.buymeacoffee.com/qITGMWB" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>

TODO.md

@@ -0,0 +1,12 @@
+# Images to PDF
+
+### To Do
+- Check the [Issues](https://github.com/Swati4star/Images-to-PDF/issues) page for open issues
+
+### In Progress ···
+Please list the issues or features you are currently working on. 
+- Add documentation for developers to understand application codebase
+
+### Done ✓
+- Main application is built
+

feature-documentation/descriptions.md

@@ -0,0 +1,40 @@
+### Creating a PDF file
+
+##### Step 1 : User can view the PDF files previously created or create a new one! 
+<img src="./screenshots/1_home.png" width="190px">
+
+
+##### Step 2 : Select the images
+<img src="./screenshots/2_1_camera.png" width="190px"> <img src="./screenshots/2_gallery.png" width="190px">
+
+
+##### Step 3 : Name the PDF file
+<img src="./screenshots/3_rename.png" width="190px">
+
+
+##### Step 4 : Creating PDF
+<img src="./screenshots/4_converting.png" width="190px">
+
+
+Hurray! PDF files of selected images are created.
+
+
+### Viewing the PDF files
+
+<img src="./screenshots/5_viewfiles.png" width="190px"> <img src="./screenshots/6_viewfiles_Action.png" width="190px">
+
+### Different themes
+Go to Settings, and you can have three type of themes : Black, Dark and White
+
+Black | Dark | White |
+--- | --- | --- |
+<img src="./screenshots/home_theme_black.png" width="190px"> | <img src="./screenshots/home_theme_dark.png" width="190px"> |  <img src="./screenshots/home_theme_white.png" width="190px"> |
+
+### Merge PDF
+<img src="./screenshots/7_merge_pdf.png" width="190px">
+
+### Text to PDF
+<img src="./screenshots/8_text_to_pdf.png" width="190px">
+
+### History
+<img src="./screenshots/9_history.png" width="190px">