mandiant/capa

review clig.dev for CLI guidelines

Open

#1,686 opened on Aug 7, 2023

View on GitHub
 (15 comments) (0 reactions) (0 assignees)Python (703 forks)github user discovery
enhancementhelp wantedusability

Repository metrics

Stars
 (6,043 stars)
PR merge metrics
 (PR metrics pending)

Description

take inspiration from https://clig.dev/ for best practices when it comes to CLI tools, like capa.

don't necessarily re-write things to adhere to the style, especially when we already have a working solution. however, if they have some good suggestions, see if we can incorporate them as appropriate.

i'll mark this as #help-wanted and #good-first-issue so that contributors can take suggestions from the items below and propose changes in dedicated PRs and issues. note: before spending a lot of time addressing one of these points, please coordinate with us to ensure we all agree on the design and/or wording.

Contributor guide

Research direction
Read the CLI guidelines at clig.dev, compare with capa's current CLI behavior and output, and propose specific improvements by creating dedicated PRs or issues. Coordinate with maintainers before implementing significant changes.
Tech stack
python
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Mostly clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75