Skip to content

docs: star-growth pass — comparison tables, CONTRIBUTING, CoC, issue/PR templates#1

Open
ModernOps888 wants to merge 3 commits into
mainfrom
docs/star-growth-pass
Open

docs: star-growth pass — comparison tables, CONTRIBUTING, CoC, issue/PR templates#1
ModernOps888 wants to merge 3 commits into
mainfrom
docs/star-growth-pass

Conversation

@ModernOps888

Copy link
Copy Markdown
Owner

Summary

  • Add a "🆚 How it compares" table to infinity-observe, infinity-data, and infinity-stream READMEs, matching the format already used in infinity-id.
  • Polish the root README: stars/forks/last-commit badges, a 2x2 dashboard screenshot grid (was text-only), a star-history chart, and a one-line "a ⭐ helps others find this" note.
  • Add CONTRIBUTING.md (build/test commands matching the existing CI matrix), CODE_OF_CONDUCT.md (Contributor Covenant v2.1), and .github issue/PR templates.

Why

Standard OSS discoverability/community hygiene — no source, CI, or dependency changes. All comparison-table claims are drawn directly from each service's own README (features/security sections already in the repo).

Test plan

  • Verified all embedded screenshot paths exist on disk (docs/img/overview.png per service)
  • Confirmed badge URLs use the correct repo path and pull live GitHub data (not fabricated numbers)
  • Repo maintainer: consider also setting GitHub topics/tags and a social preview image in repo settings — not doable via PR, but the single biggest lever left for discovery

…mplates

Bring Observe/Data/Stream READMEs to parity with ID's "How it compares"
table, add a visual + star/fork badges to the root README, and add the
community files (CONTRIBUTING, CODE_OF_CONDUCT, issue/PR templates)
expected of an actively maintained OSS project.
Copilot AI review requested due to automatic review settings July 21, 2026 12:22

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves Infinity Stack’s OSS “surface area” and contributor onboarding by polishing READMEs (badges, visuals, comparison tables) and adding standard community files/templates.

Changes:

  • Adds “🆚 How it compares” comparison tables to the Observe/Data/Stream service READMEs (aligning with the existing Infinity ID format).
  • Enhances the root README with GitHub badges, a 2x2 service dashboard image grid, and a Star History chart.
  • Introduces community hygiene files: CONTRIBUTING.md, CODE_OF_CONDUCT.md, plus GitHub issue/PR templates.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
README.md Adds repo badges, service overview image grid, and Star History embed.
infinity-stream/README.md Adds a “How it compares” table for Infinity Stream.
infinity-observe/README.md Adds a “How it compares” table for Infinity Observe.
infinity-data/README.md Adds a “How it compares” table for Infinity Data.
CONTRIBUTING.md Adds contributor setup + CI-aligned local command checklist.
CODE_OF_CONDUCT.md Adds Contributor Covenant v2.1 Code of Conduct text.
.github/PULL_REQUEST_TEMPLATE.md Adds a structured PR template with per-service checklist.
.github/ISSUE_TEMPLATE/feature_request.md Adds a feature request issue template.
.github/ISSUE_TEMPLATE/bug_report.md Adds a bug report issue template.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md
Comment on lines +21 to +24
cargo check --workspace --all-targets
cargo test --workspace
cargo clippy --workspace --all-targets -- -D warnings
cargo audit
Comment thread CODE_OF_CONDUCT.md

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue in this repository, or, if the report concerns another user and you'd prefer not to be public about it, by contacting a maintainer directly through their GitHub profile. All complaints will be reviewed and investigated promptly and fairly.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants