CSSG-Labs/flask-todo-app

Improve CONTRIBUTING.md documentation

Open

#32 opened on May 11, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)HTML (4 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

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

Requirements

  • Improved steps should be clear and descriptive
  • There should be visual elements (screenshots or video)

Contributor guide

Research direction
Read the current CONTRIBUTING.md, then refer to the Flask installation guide for Linux and macOS, and document the steps with screenshots and a video.
Tech stack
pythonflask
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85