MLH-Fellowship / MLH-Fellowship/LarynxCode

Create web app for User Guide

Open
#7 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backend code enhancement frontend webapp
Dominant language
Python
Stars
1
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Description

Create a basic web app for the CLI flag --caster-help, that'll provide users with command guide / redirect them to the Caster official guides.

Acceptance Criteria

  • Code must be properly formatted.
  • Code must be accompanied by appropriate comments.
  • File structure must be strictly maintained.
  • Test cases must be present at the end of the code (for feature enhancements)
  • Variables and functions must be properly named
  • IMPORTANT: Make sure requirements.txt file is updated if you are including any new library.
  • Must match the Description

Definition of Done

  • All of the required items are completed.
  • Approval by 1 mentor/the maintainer

Time Estimation

By Sunday.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin by locating the Python implementation of the CLI flag --caster-help and the Flask web-app entry point. Done means the flag provides a command guide or redirects users to the official Caster guides; also check the stated requirements for comments, tests, formatting, and requirements.txt updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
flask, python
Domain
cli, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.