CSSG-Labs / CSSG-Labs/flask-todo-app

Improve CONTRIBUTING.md documentation

Open
#32 0 comments 0 reactions 1 assignee Claimed by @andromedamoon-stack View on GitHub
documentation good first issue
Dominant language
HTML
Stars
2
Forks
4
PR merge metrics
No merged PRs in 30d

Description

**What**
- Adds linux and macOS instructions in CONTRIBUTING.md's "Development Environment Setup" section
- Adds video and screenshots to make the process easier to understand

**Why**
- Current document does not provide instructions for linux or macOs
- Also does not provide enough explanation in the steps
- Lack of detailed instructions hurts the onboarding process for new members

**How**
- [Flask tutorial](https://flask.palletsprojects.com/en/2.1.x/installation/)
- [Video on setting up application on windows](https://drive.google.com/file/d/1DAtgfW_B5ObfO0uKejvPCoJbrGXlwpZq/view?usp=sharing)

**Requirements**
- Improved steps should be clear and descriptive
- There should be visual elements (screenshots or video)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.