8000 llama_index/STALE.md at main · hmmhmmhm/llama_index · GitHub
[go: up one dir, main page]
Skip to content
{"props":{"color_mode":"dark","logged_in":false,"marketing_page":false,"home_path":"/","login_path":"/login?return_to=https%3A%2F%2FGitHub.com%2Fhmmhmmhm%2Fllama_index%2Fblob%2Fmain%2FSTALE.md","signup_path":"/signup?ref_cta=Sign+up\u0026ref_loc=header+logged+out\u0026ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fblob%2Fshow\u0026source=header-repo\u0026source_repo=hmmhmmhm%2Fllama_index","signup_enabled":true,"is_signup_controller":false,"show_search_and_nav":true,"hide_search":false,"private_mode_enabled":false,"should_use_dotcom_links":true,"auth_hydro_click":"{\"event_type\":\"authentication.click\",\"payload\":{\"location_in_page\":\"site header menu\",\"repository_id\":null,\"auth_type\":\"SIGN_UP\",\"originating_url\":\"https://GitHub.com/hmmhmmhm/llama_index/blob/main/STALE.md\",\"user_id\":null}}","auth_hydro_click_hmac":"6c374b3d67611172f74345909c3e9d71bdcf0e1af479e59119c203d4ecd30680"}}

STALE.md

Latest commit

 

History

History
65 lines (41 loc) · 2.24 KB

STALE.md

File metadata and controls

65 lines (41 loc) · 2.24 KB
Raw

Stale Package Policy

Overview

To maintain high quality across all LlamaIndex integrations, we periodically review packages for staleness. Packages marked as "stale" are moved to a stale_packages branch but remain published on PyPI. This policy ensures that our main branch contains only well-maintained, tested integrations while preserving access to historical integrations.

Staleness Criteria

Packages are evaluated using an automated health check that considers:

  1. Test Coverage (50% of score)

    • Full credit (1.0): 5+ test functions
    • Partial credit (0.5): 2-4 test functions
    • No credit (0.0): 0-1 test functions

  2. Download Activity (40% of score)

    • Measured relative to llama-index-core
    • Considers monthly download counts
    • Weighted towards recent activity

  3. Commit Activity (10% of score)

    • Measured relative to llama-index-core
    • Considers commit frequency and consistency
    • Weighted towards recent commits

The resulting score is then used to determine the health of the package.

Moving to Stale Status

A package may be moved to the stale_packages branch if:

  1. It has a low health score (typically below 0.005)
  2. AND lacks adequate test coverage
  3. OR has known breaking issues that haven't been addressed

The final decision to mark a package as stale involves human review and is not purely automated.

Effects of Stale Status

When a package is marked as stale:

  1. The package code is moved to the stale_packages branch
  2. Documentation is removed from the main documentation site
  3. The package remains published on PyPI

Reactivating a Stale Package

Any contributor can reactivate a stale package by:

  1. Creating a PR to move any package from the stale_packages branch to main
  2. Ensuring the package has adequate test coverage (minimum 2 tests)
  3. Verifying that all tests pass
  4. Updating documentation as needed

Questions or Concerns

If you maintain a package that has been marked as stale, or have questions about this policy:

  1. Open a GitHub issue for discussion
  2. Reach out to the maintainers on Discord
  3. Submit a PR to reactivate your package with improvements

We aim to be transparent and collaborative in maintaining package quality while preserving access to all integrations.
0