docs: add comprehensive local setup & onboarding guide #82
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a comprehensive onboarding guide for the Foodium Android application, covering setup, running the app, testing, code quality, and contribution guidelines.
Create onboarding guide for Foodium Android app
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
- Summary
This PR enhances the README by adding a concise and actionable Local Setup & Onboarding section for new contributors and users. The previous README showcased architecture and technologies but lacked step-by-step guidance to clone, build, run, test, and contribute.
The pr content focuses on:
- Description for the changelog
docs: add detailed local setup, build, test, and troubleshooting guide to README
- A picture or screenshot regarding change (not mandatory but encouraged)