Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (54 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

75 lines (54 loc) · 3.08 KB
Raw

Contributing

Thank you for helping improve Awesome Python Ecosystem. The goal is a curated, maintainable guide that helps readers decide which Python libraries to evaluate first.

What to Contribute

Useful contributions include:

  • New library suggestions.
  • Corrections to official documentation, source, or PyPI links.
  • Clearer descriptions.
  • Better category placement.
  • Maintenance-status corrections.
  • Removal proposals for obsolete, unsafe, renamed, archived, or superseded projects.
  • Comparison improvements that explain tradeoffs without declaring universal winners.

Required Information for New Libraries

Please include:

  • Project name using the official capitalization.
  • Proposed category.
  • One-sentence rationale for inclusion.
  • Official documentation link.
  • Canonical source repository link.
  • PyPI link and exact install name when the package is distributed through PyPI.
  • License.
  • Evidence of current maintenance or enduring relevance.

Selection Criteria

Maintainers evaluate submissions for:

  • Clear purpose and practical usefulness.
  • Official source and documentation.
  • Recognized license or clearly documented licensing model.
  • Maintenance activity, release recency, and issue or pull-request health.
  • Ecosystem adoption and relevance.
  • Security posture and legitimacy.
  • Whether the project is archived, renamed, abandoned, or superseded.
  • Whether the package name could be confused with typosquatting or dependency-confusion risks.

GitHub stars can be useful context, but they are not sufficient on their own.

Description Style

  • Write in professional, natural English.
  • Use one concise sentence for the main description.
  • Do not copy project taglines or text from another awesome list.
  • Avoid marketing language, hype, and unsupported claims.
  • Do not call a project the best, largest, or most complete.
  • Mention unusual licensing constraints when they materially affect adoption.

Category Choice

Choose the most useful category for a reader deciding what to build. Avoid duplicating the same project across many sections. If a project fits several categories, prefer the strongest category and add a short cross-reference only when it improves navigation.

Ordering Rules

  • Keep entries grouped by reader intent.
  • Within narrow subsections, prefer alphabetical ordering unless an established flow is clearer.
  • Keep essential and comparison sections editorial rather than strict rankings.

Pull Request Expectations

  • Keep pull requests focused.
  • Include enough evidence for maintainers to verify links, license, and maintenance status.
  • Do not add generated package dumps.
  • Do not add random tutorials, mirrors, SEO pages, or unofficial documentation when official links exist.
  • Check Markdown formatting before submitting.
  • Avoid adding duplicate URLs or duplicate project entries.

Reporting Obsolete or Risky Projects

Open an issue or pull request if a listed project appears archived, compromised, renamed, superseded, unmaintained, incorrectly linked, or unsafe to install. Include the evidence you found and suggest removal, relabeling, or replacement.