Skip to content
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 documentations #1135

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update documentations #1135

wants to merge 1 commit into from

Conversation

SusBhh
Copy link

@SusBhh SusBhh commented Oct 2, 2023

Description

Updated README file

  • I updated the README file to include the new features in the app that were not documented and linked the list of features to the corresponding section in the file.

Update CONTRIBUTING file

  • I added a more detailed description of how to build and run the app as a developer.

Fixes #(issue)

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
  • ./gradlew checkstyle

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
Copy link

codeclimate bot commented Oct 2, 2023

Code Climate has analyzed commit 7663afe and detected 0 issues on this pull request.

View more on Code Climate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant