jazzband/pip-tools

Refactor README

Open

#1,845 opened on Apr 6, 2023

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Python (605 forks)batch import
docshelp wanted

Repository metrics

Stars
 (7,230 stars)
PR merge metrics
 (Avg merge 4d 20h) (9 merged PRs in 30d)

Description

What's the problem this feature will solve?

Since the README file has become quite large, perhaps it's time we consider refactoring it.

Describe the solution you'd like

  • Make README small and concise focusing on important things
  • Keep on README description, svg image, installation and basic usage of the pip-tools
  • Move the other sections to https://pip-tools.rtfd.io/

References:

Alternative Solutions

N/A

Additional context

/cc @jamescooke

Contributor guide

Research direction
Review the current README and identify sections to move to the documentation site (pip tools.rtfd.io). Check the existing documentation structure and update the README accordingly.
Tech stack
python
Domain
documentation
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.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80