Issue: Insufficient clarity in the contribution guide causing users to face difficulties running the app

[WojuadeAA]

Issue Summary: Users are encountering difficulties when trying to run the application due to insufficient clarity in the contribution guide. This issue aims to address the need for improved documentation or instructions to ensure a smoother onboarding experience for new contributors.

Steps to Reproduce:

1. Follow the steps outlined in the current contribution guide to set up the project.
2. Attempt to run the application as per the provided instructions.
3. Encounter difficulties or obstacles preventing successful execution of the app.

Expected Behavior: The contribution guide should provide clear and detailed instructions for running the application, allowing users to easily set up and run the app without encountering issues.

Actual Behavior: The current contribution guide lacks clarity in certain areas, leading to confusion and hindrance when attempting to run the app. Users may face difficulties in understanding the required dependencies, configurations, or steps involved.

Additional Information: Please provide any additional information that may be relevant to the issue, such as specific error messages encountered, the platform or environment used, or any other details that can help in addressing the problem effectively.

Proposed Solution: To resolve this issue, it is recommended to:

1. Review and revise the existing contribution guide, focusing on improving the clarity and completeness of the instructions for running the app.
2. Include detailed steps, dependencies, configurations, and any potential troubleshooting tips to guide users through the process.
3. Consider adding examples, code snippets, or screenshots where applicable to further clarify the required steps.
4. Encourage feedback from users or contributors to identify specific areas of confusion or improvement suggestions.

Acceptance Criteria: The revised contribution guide should:

• Provide clear, concise, and easy-to-follow instructions for setting up and running the application.
• Address common challenges or obstacles that users may face during the setup process.
• Ensure that users can successfully run the application without encountering major issues.

This issue is critical to enhance the user experience and attract more contributors to the project. It is recommended to prioritize and address this issue promptly to improve the overall usability and accessibility of the project.

[WojuadeAA]

@adekunbee

[adekunbee]

.take

[github-actions[bot]]

Thanks for taking this on and trying to contribute to the Ibadan Techies! If you have not already, consider joining the club as a member. You can start from joining the conversation on our Discord (coming soon!) or Twitter.