Skip to content

chore: add CHANGELOG.md and FUNDING.yml#33

Merged
vineethwilson15 merged 2 commits intomasterfrom
chore/oss-housekeeping
Mar 7, 2026
Merged

chore: add CHANGELOG.md and FUNDING.yml#33
vineethwilson15 merged 2 commits intomasterfrom
chore/oss-housekeeping

Conversation

@vineethwilson15
Copy link
Owner

@vineethwilson15 vineethwilson15 commented Mar 7, 2026

  • CHANGELOG.md: Keep-a-Changelog format starting at v0.0.1 (initial scaffold) with an Unreleased section tracking Phase 1 remaining work
  • .github/FUNDING.yml: placeholder funding config — fills in when GitHub Sponsors or Open Collective is set up; GitHub will show a "Sponsor" button on the repo

Summary by CodeRabbit

  • Documentation

    • Added a comprehensive CHANGELOG with an Unreleased section and initial 0.0.1 release notes detailing project scaffold, core components, CLI, tests, and deployment hints.
    • Added a GitHub funding configuration to surface sponsorship options.
  • Chores

    • Added project metadata files to track releases and funding.

- CHANGELOG.md: Keep-a-Changelog format starting at v0.0.1 (initial
  scaffold) with unreleased section for Phase 1 remaining steps
- .github/FUNDING.yml: placeholder funding config ready to fill when
  GitHub Sponsors or Open Collective is set up
@coderabbitai
Copy link

coderabbitai bot commented Mar 7, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 06231e24-bc9c-4285-8b1c-7373f9861472

📥 Commits

Reviewing files that changed from the base of the PR and between d649ed3 and 71d2cf6.

📒 Files selected for processing (1)
  • .github/FUNDING.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/FUNDING.yml

Walkthrough

Adds .github/FUNDING.yml with Open Collective configured and commented placeholders for other funding sources, and adds CHANGELOG.md documenting an Unreleased section and a 0.0.1 release (2026-03-07) detailing project scaffold and components like Neo4j/Qdrant dual-store, CLI, CI/CD, and tests.

Changes

Cohort / File(s) Summary
Funding Configuration
.github/FUNDING.yml
New GitHub funding configuration: open_collective: codemind with commented placeholders for github and patreon.
Project Changelog
CHANGELOG.md
Adds changelog with Unreleased plans and 0.0.1 (2026-03-07) release notes covering scaffold, core/indexer dual-store (Neo4j + Qdrant), core/graph Neo4j client, CLI, tests, docker-compose, .env.example, and CI/CD.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title accurately describes the main changes: adding CHANGELOG.md and FUNDING.yml configuration files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/oss-housekeeping

Comment @coderabbitai help to get the list of available commands and usage tips.

@vineethwilson15 vineethwilson15 enabled auto-merge (squash) March 7, 2026 15:39
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/FUNDING.yml:
- Around line 3-6: The FUNDING.yml currently has all provider keys commented and
the custom array empty, so GitHub won't render a Sponsor button; either populate
the custom array with one or more actual funding URLs (e.g., set custom:
["https://your-funding-url"]) or uncomment and fill a recognized provider key
(github, patreon, open_collective) with the correct identifier, or remove the
file entirely if you don't want any funding links displayed; update the
`custom`/`github`/`patreon`/`open_collective` entries accordingly.

In `@CHANGELOG.md`:
- Around line 20-36: The changelog references a released version that doesn't
exist yet: either create the git tag and GitHub release named v0.0.1 before
merging so the existing [0.0.1] and compare links resolve, or move the "##
[0.0.1] — 2026-03-07" entry under the [Unreleased] heading (or replace the
reference links to point to [Unreleased]) so the changelog only lists releases
that actually exist; ensure the reference labels `[0.0.1]` and `[Unreleased]`
and their URL footers are updated consistently to match whichever approach you
choose.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 67a3abea-7b9f-47fe-ab37-b89d44797901

📥 Commits

Reviewing files that changed from the base of the PR and between 997ec98 and d649ed3.

📒 Files selected for processing (2)
  • .github/FUNDING.yml
  • CHANGELOG.md

GitHub only displays the Sponsor button for uncommented keys with values.
Remove empty custom: [] placeholder and uncomment open_collective: codemind
so the button appears immediately. GitHub and Patreon entries remain
commented until those accounts are set up.
@vineethwilson15
Copy link
Owner Author

@coderabbitai resolve

@vineethwilson15 vineethwilson15 merged commit fc8416a into master Mar 7, 2026
11 checks passed
@vineethwilson15 vineethwilson15 deleted the chore/oss-housekeeping branch March 7, 2026 15:51
@coderabbitai
Copy link

coderabbitai bot commented Mar 7, 2026

✅ Actions performed

Comments resolved and changes approved.

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.

1 participant