-
Notifications
You must be signed in to change notification settings - Fork 795
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation #1086
base: master
Are you sure you want to change the base?
Update documentation #1086
Conversation
Code Climate has analyzed commit 3737de2 and detected 0 issues on this pull request. View more on Code Climate. |
Further DetailsI 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we skip adding this todo file? It's not exactly adding any value and would definitely not be maintained.
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer to keep this section in README file. It helps people in understanding what exactly the project is.
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.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
./gradlew assembleDebug assembleRelease
did not pass./gradlew checkstyle
passed after removing unrecognized jvm option "MaxPermSize=4096m"Checklist: