docs: add troubleshooting section for local setup#422
Open
WaizKayani wants to merge 1 commit intohatnote:masterfrom
Open
docs: add troubleshooting section for local setup#422WaizKayani wants to merge 1 commit intohatnote:masterfrom
WaizKayani wants to merge 1 commit intohatnote:masterfrom
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
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.
What I changed
Added a troubleshooting section to the README to help with common local setup issues.
Why
While setting up the project locally, I ran into a few common issues related to Python version compatibility, setuptools/pkg_resources, missing config.dev.yaml, and database setup. This adds a simple troubleshooting section to make onboarding easier for new contributors.
Notes
These steps are based on issues encountered during local setup.