rygel/needlecast

Number of days since the most recent commit to the default branch.

Why it matters: Fresher commits indicate active maintenance and faster bug-fix turnaround.

How to improve:

• Set up automated dependency updates to maintain regular commit activity.
• Use CI/CD pipelines to enforce consistent integration cycles.
• Adopt trunk-based development to keep the main branch moving.

Average number of commits pushed per month over the project's lifetime.

Why it matters: Higher commit frequency correlates with steady progress and responsiveness.

How to improve:

• Encourage small, focused commits rather than large batch changes.
• Use feature flags to merge work-in-progress safely.
• Set team commit cadence goals and track progress in dashboards.

Number of days since the most recent versioned release was published.

Why it matters: Regular releases give users access to fixes and features, signalling a healthy delivery cycle.

How to improve:

• Automate releases via CI with semantic versioning tools.
• Adopt a time-based release schedule (e.g., every 2 weeks).
• Publish pre-releases to gather feedback before stable releases.

Whether commit activity is growing, stable, or declining over recent months.

Why it matters: A growing or stable trend indicates sustained project momentum.

How to improve:

• Recruit new contributors through good-first-issue labels.
• Publish roadmap and contribution guides to attract participation.
• Schedule regular community events like hack sessions.

Average number of days between consecutive releases.

Why it matters: Predictable release cadence builds user trust and simplifies upgrade planning.

How to improve:

• Automate the release pipeline to reduce manual overhead.
• Use semantic versioning to communicate change impact clearly.
• Maintain a changelog to make releases transparent and discoverable.

Presence and length of the repository's README file.

Why it matters: A substantial README is the first impression for potential users and contributors.

How to improve:

• Include installation, usage, and contribution sections.
• Add badges for build status, coverage, and license.
• Keep language clear and provide code examples.

Score from 0 to 4 measuring how many key README signals are present.

Why it matters: Quality READMEs reduce onboarding friction and improve discoverability.

How to improve:

• Ensure the README includes a project description and usage examples.
• Link to documentation, API references, and contribution guides.
• Add a table of contents for longer documents.

Whether the repository includes an open-source license file.

Why it matters: A license determines how others can use, modify, and distribute the code.

How to improve:

• Choose an OSI-approved license that matches your project goals.
• Place the LICENSE file at the repository root.
• Use SPDX identifiers in package metadata.

Whether the repository has a CONTRIBUTING.md or equivalent guide.

Why it matters: Clear contribution guidelines lower barriers for new contributors.

How to improve:

• Document the PR submission and review process.
• List coding standards and required tests.
• Provide templates for issues and pull requests.

Whether the repository has a SECURITY.md or security policy.

Why it matters: A security policy gives researchers a responsible disclosure path.

How to improve:

• Create a SECURITY.md with contact and disclosure procedures.
• Set up automated dependency vulnerability scanning.
• Define SLAs for acknowledging and patching reported issues.