Repository navigation
docs: credit the upstream engine, project page and production README header - #1
Conversation
…header - README: a centred header that names the hackathon work (BrainVault, the agentic chat pipeline) and credits the HippocampAI engine by Rex Divakar (rexdivakar/HippocampAI, Apache 2.0), which the package metadata already names as the author. Emoji removed from five headings and two lines; no other text changed. - CODE_OF_CONDUCT, SUPPORT, an issue config with the private security link, and a PR template. CONTRIBUTING and SECURITY already exist in docs/ and are untouched. - site/: the project page, published by .github/workflows/pages.yml to https://boss477.github.io/HippocampAI/. - Repository settings applied separately: description, topics and private vulnerability reporting (the SECURITY policy links to it). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
There was a problem hiding this comment.
3 issues found across 7 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="SUPPORT.md">
<violation number="1" location="SUPPORT.md:6">
P2: This security link is broken: the repository contains `docs/SECURITY.md`, not root-level `SECURITY.md`, and the linked document would not direct a reporter to the private advisory form anyway. Link directly to the private vulnerability reporting URL (and optionally the policy) so security reports do not become blocked or public.</violation>
</file>
<file name="README.md">
<violation number="1" location="README.md:13">
P3: This hard-coded badge misstates the supported Python range by presenting 3.11 as the project version. Use a badge that reflects the declared `>=3.9` support (or a dynamic PyPI versions badge) so users do not miss compatible Python versions.</violation>
</file>
<file name=".github/pull_request_template.md">
<violation number="1" location=".github/pull_request_template.md:9">
P3: This checkbox refers to BrainVault export/restore tools that are not present in the repository, so contributors cannot perform the requested verification. Remove this repository-specific requirement or add the referenced implementation before asking contributors to test it.</violation>
</file>
Reply with feedback, questions, or to request a fix.
View guided diff | Turn on auto-fix | Re-trigger cubic
| - **Something is broken:** open an issue with the bug report form. Include what you ran, what you | ||
| expected and what happened. | ||
| - **An idea or a missing feature:** open an issue with the feature request form. | ||
| - **A security problem:** do not open a public issue. Follow [SECURITY.md](SECURITY.md). |
There was a problem hiding this comment.
P2: This security link is broken: the repository contains docs/SECURITY.md, not root-level SECURITY.md, and the linked document would not direct a reporter to the private advisory form anyway. Link directly to the private vulnerability reporting URL (and optionally the policy) so security reports do not become blocked or public.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At SUPPORT.md, line 6:
<comment>This security link is broken: the repository contains `docs/SECURITY.md`, not root-level `SECURITY.md`, and the linked document would not direct a reporter to the private advisory form anyway. Link directly to the private vulnerability reporting URL (and optionally the policy) so security reports do not become blocked or public.</comment>
<file context>
@@ -0,0 +1,9 @@
+- **Something is broken:** open an issue with the bug report form. Include what you ran, what you
+ expected and what happened.
+- **An idea or a missing feature:** open an issue with the feature request form.
+- **A security problem:** do not open a public issue. Follow [SECURITY.md](SECURITY.md).
+
+This project is maintained in the open by [@boss477](https://github.com/boss477). Answers are best
</file context>
| - **A security problem:** do not open a public issue. Follow [SECURITY.md](SECURITY.md). | |
| - **A security problem:** do not open a public issue. [Report it privately](https://github.com/boss477/HippocampAI/security/advisories/new). |
| <p align="center"> | ||
| <a href="https://github.com/boss477/HippocampAI/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/boss477/HippocampAI/actions/workflows/ci.yml/badge.svg"></a> | ||
| <a href="LICENSE"><img alt="license: Apache 2.0" src="https://img.shields.io/badge/license-Apache%202.0-1b5e3b"></a> | ||
| <img alt="python: 3.11" src="https://img.shields.io/badge/python-3.11-1b5e3b?logo=python&logoColor=white"> |
There was a problem hiding this comment.
P3: This hard-coded badge misstates the supported Python range by presenting 3.11 as the project version. Use a badge that reflects the declared >=3.9 support (or a dynamic PyPI versions badge) so users do not miss compatible Python versions.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At README.md, line 13:
<comment>This hard-coded badge misstates the supported Python range by presenting 3.11 as the project version. Use a badge that reflects the declared `>=3.9` support (or a dynamic PyPI versions badge) so users do not miss compatible Python versions.</comment>
<file context>
@@ -1,14 +1,28 @@
+<p align="center">
+ <a href="https://github.com/boss477/HippocampAI/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/boss477/HippocampAI/actions/workflows/ci.yml/badge.svg"></a>
+ <a href="LICENSE"><img alt="license: Apache 2.0" src="https://img.shields.io/badge/license-Apache%202.0-1b5e3b"></a>
+ <img alt="python: 3.11" src="https://img.shields.io/badge/python-3.11-1b5e3b?logo=python&logoColor=white">
+ <img alt="SanDisk Hackathon: 1st runner-up" src="https://img.shields.io/badge/SanDisk%20Hackathon-1st%20runner--up-b08900">
+ <a href="https://boss477.github.io/HippocampAI/"><img alt="website: boss477.github.io" src="https://img.shields.io/badge/website-boss477.github.io-1b5e3b"></a>
</file context>
| <img alt="python: 3.11" src="https://img.shields.io/badge/python-3.11-1b5e3b?logo=python&logoColor=white"> | |
| <img alt="python: 3.9+" src="https://img.shields.io/badge/python-3.9%2B-1b5e3b?logo=python&logoColor=white"> |
|
|
||
| - [ ] `pytest` passes | ||
| - [ ] `ruff check .` and `ruff format --check .` are clean | ||
| - [ ] Tried the BrainVault export and restore if the change touches them |
There was a problem hiding this comment.
P3: This checkbox refers to BrainVault export/restore tools that are not present in the repository, so contributors cannot perform the requested verification. Remove this repository-specific requirement or add the referenced implementation before asking contributors to test it.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At .github/pull_request_template.md, line 9:
<comment>This checkbox refers to BrainVault export/restore tools that are not present in the repository, so contributors cannot perform the requested verification. Remove this repository-specific requirement or add the referenced implementation before asking contributors to test it.</comment>
<file context>
@@ -0,0 +1,14 @@
+
+- [ ] `pytest` passes
+- [ ] `ruff check .` and `ruff format --check .` are clean
+- [ ] Tried the BrainVault export and restore if the change touches them
+
+## Checklist
</file context>
| - [ ] Tried the BrainVault export and restore if the change touches them | |
| - [ ] Tried the relevant feature flow if the change touches it |
🤖 Generated with Claude Code
Summary by cubic
Polishes the project for production: the README header now credits the upstream HippocampAI engine by Rex Divakar (Apache 2.0), names the hackathon work, and drops emoji from headings and lines.
CODE_OF_CONDUCT,SUPPORT, an issue config pointing security reports to private advisories, and a pull request template.site/, deployed to https://boss477.github.io/HippocampAI/ by a GitHub Pages workflow.Written for commit f6d8b88. Summary will update on new commits.