Closed vaishnavipal1869 closed 3 weeks ago
Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊
Description
This PR does the following:
- Adds a troubleshooting section to the README file to assist users with common issues encountered during installation and server setup.
- Provides FAQs to address frequent questions regarding the local database and support contact.
Related Issues
Changes
List the detailed changes made in this PR:
Added a new troubleshooting section covering:
- Common installation issues
- Problems with starting the server
- Issues related to dependencies
- Frequently asked questions (FAQs)
Testing Instructions
Detailed instructions on how to test the changes:
- Pull this branch.
- Check out the README file to review the newly added troubleshooting section.
- Ensure that the troubleshooting instructions accurately reflect common issues and provide clear resolutions.
Screenshots (if applicable)
- not applicable.
Additional Context
- This PR is based on the feedback received from users facing installation issues. The added troubleshooting section aims to streamline the onboarding process and reduce confusion for new users.
Checklist
Make sure to check off all the items before submitting:
- [x] I have performed a self-review of my code.
- [x] I have commented on my code, particularly in hard-to-understand aras.
- [x] My changes generate no new warnings.
- [x] I am working on this issue under GSSOC.
Kindly add some screenshot or screen recording of the features you have added. @vaishnavipal1869
@vaishnavipal1869 Add a screenshot of the troubleshooting section you have added in the markdown file.
@vaishnavipal1869 Add a screenshot of the troubleshooting section you have added in the markdown file.
hello @Suman373 , Since my changes were purely related to documentation, I believe a screenshot may not be necessary in this case. However, if a screenshot is still required, I can provide one of the README file showing the updates. Please let me know how you'd prefer to proceed.
@vaishnavipal1869 Add a screenshot of the troubleshooting section you have added in the markdown file.
hello @Suman373 , Since my changes were purely related to documentation, I believe a screenshot may not be necessary in this case. However, if a screenshot is still required, I can provide one of the README file showing the updates. Please let me know how you'd prefer to proceed.
Although you have made documentation changes, a screenshot for the updated markdown file especially your changes is necessary. I have checked it so you don't have to update the PR but make sure to add it from next time onwards. Anyway, nice work ! We look forward to more contributions from your side 👍
@Trisha-tech you may verify and merge it
@vaishnavipal1869 Add a screenshot of the troubleshooting section you have added in the markdown file.
hello @Suman373 , Since my changes were purely related to documentation, I believe a screenshot may not be necessary in this case. However, if a screenshot is still required, I can provide one of the README file showing the updates. Please let me know how you'd prefer to proceed.
Although you have made documentation changes, a screenshot for the updated markdown file especially your changes is necessary. I have checked it so you don't have to update the PR but make sure to add it from next time onwards. Anyway, nice work ! We look forward to more contributions from your side 👍
Apologies for not including the screenshots earlier. If you'd like, I can add them right away—just let me know how you'd like me to proceed. I appreciate the feedback and will make sure to include them in future updates
@vaishnavipal1869 Add a screenshot of the troubleshooting section you have added in the markdown file.
hello @Suman373 , Since my changes were purely related to documentation, I believe a screenshot may not be necessary in this case. However, if a screenshot is still required, I can provide one of the README file showing the updates. Please let me know how you'd prefer to proceed.
Although you have made documentation changes, a screenshot for the updated markdown file especially your changes is necessary. I have checked it so you don't have to update the PR but make sure to add it from next time onwards. Anyway, nice work ! We look forward to more contributions from your side 👍
Apologies for not including the screenshots earlier. If you'd like, I can add them right away—just let me know how you'd like me to proceed. I appreciate the feedback and will make sure to include them in future updates
Its okay ! 😊
Description
This PR does the following:
Related Issues
Changes
List the detailed changes made in this PR:
Testing Instructions
Detailed instructions on how to test the changes:
Screenshots (if applicable)
Additional Context
Checklist
Make sure to check off all the items before submitting: