Skip to content

Improve Readme #9

Description

@neeldoshii

Improvements

Currently the readme contains just CHATGPT contents just about some features of the app. I would like to have full revamp.

I like the proper documented like this references to
https://github.com/Automattic/pocket-casts-android
https://github.com/Ivy-Apps/ivy-wallet

Content Flow:

  1. One-two line description about the app.
    Install link (currently the app is not on play store so will provide release build ATM. We are soon goanna launch it to play store so will add play store link later on
  2. Need of this app.
  3. Directory Structure Explanation
    Reference
    image
  4. Whenever someone raises a PR what guidelines should be done ---
    Need similar to this
    https://github.com/Automattic/pocket-casts-android/blob/main/docs/pull-request-guidelines.md
    https://github.com/Automattic/pocket-casts-android/blob/main/.github/pull_request_template.md
  5. Tech Stack Used
  6. Contributors Name and Photo

Would love to hear more things which we can add on so we can provide smooth onboarding to new contributors.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions