docs: add community-health files (SECURITY, CODE_OF_CONDUCT, CONTRIBUTING)#29
Open
jhamon wants to merge 1 commit into
Open
docs: add community-health files (SECURITY, CODE_OF_CONDUCT, CONTRIBUTING)#29jhamon wants to merge 1 commit into
jhamon wants to merge 1 commit into
Conversation
…TING) The org `pinecone-io/.github` repo supplies only ISSUE_TEMPLATE and a PR template, so this repo had no security policy, code of conduct, or contributing guide. Add all three at the repo root so GitHub renders them in the Community/Insights tab. Closes #26 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
This public repo had no
SECURITY.md,CODE_OF_CONDUCT.md, orCONTRIBUTING.md. The orgpinecone-io/.githubrepo does not supply them as defaults — it provides onlyISSUE_TEMPLATE/andpull_request_template.md— so GitHub showed no security policy, code of conduct, or contributing guide for the repo.Solution
Add all three files at the repo root (where LICENSE and README already live;
.github/here holds only workflows), so GitHub auto-detects and renders them in the Community/Insights tab.SECURITY.md— scopes the repo as an example, and routes private disclosure two ways: GitHub's Report a vulnerability form for issues in this sample code, andsecurity@pinecone.iofor platform/SDK vulnerabilities. No public issues for security problems.CODE_OF_CONDUCT.md— standard Contributor Covenant v2.1, verbatim except the enforcement contact, which points to the real, routablesupport@pinecone.iorather than a fabricated conduct-specific inbox.CONTRIBUTING.md— repo-accurate onboarding: Node 20+ (matching the CI matrix),npm install,cp .env.example .env, and the exact scripts CI runs (lint,format:check,typecheck,test) plus how to run the demo (npm run index/npm run recommend). Every referenced script was verified to exist inpackage.json.Docs-only change with no runtime surface. Local checks pass (lint, format:check, typecheck, and 23/23 tests); the new Markdown files fall outside the lint (
src) and format (**/*.ts) globs, so CI is unaffected.Closes #26
Refs #27
🤖 Generated with Claude Code