Repository navigation
docs: add missing governance files (CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, LICENSE) - #13
Merged
Merged
Conversation
…ONDUCT, LICENSE) Fills gaps confirmed missing (404) during the org-wide docs cleanup pass. Verification commands in CONTRIBUTING.md are pulled from the real CI workflow (.github/workflows/ci.yml: ruff check . / pytest -q) rather than copied from BinancePlatform. SECURITY.md reflects that private vulnerability reporting is NOT enabled for this repo (verified via `gh api repos/QuantStrategyLab/AlpacaPlatform/private-vulnerability-reporting`) and scopes risk language to the repo's actual current surface (P5 SHADOW only, no broker connectivity/credentials yet; future P4 PAPER_DRY_RUN). LICENSE text matches BinancePlatform's merged MIT license verbatim. README.md was intentionally left untouched per task scope. README.zh-CN.md was intentionally NOT created in this pass -- see PR description for why. Co-Authored-By: Claude Sonnet 5 <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
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.
Summary
CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md,LICENSE.CONTRIBUTING.mdusesBinancePlatform's merged file as a style reference, but local verification commands are pulled from this repo's real CI (.github/workflows/ci.yml):ruff check .andpytest -q, not Binance'sunittest discovercommand.SECURITY.mdis scoped to what this repo actually does today: a bounded Alpaca paper/shadow execution gateway, currently only implementing the P5SHADOWstage (no broker connectivity, no credentials, no order submission). I checkedgh api repos/QuantStrategyLab/AlpacaPlatform/private-vulnerability-reportingand it returned{"enabled": false}, so the doc does not claim that reporting channel exists (unlike BinancePlatform's doc, which assumes it may be available). Maintainer contact is@Pigbibi, confirmed as the sole author/committer in this repo's git history.CODE_OF_CONDUCT.mdmatches BinancePlatform's structure (Our Standards / Project Scope / Reporting and Enforcement), with the Project Scope paragraph rewritten for AlpacaPlatform's actual purpose.LICENSEis the exact MIT text from BinancePlatform's mergedLICENSE(same copyright line:Copyright (c) 2026 QuantStrategyLab).Explicitly NOT done in this PR (and why)
README.mdwas not touched. Confirmed it's already well-written prose with no## QSL architecture rolefield-list block to clean up, per the task scope.README.zh-CN.mdwas not created, and no language-switcher link was added to either README. Reason: the task assumedREADME.mdis in English (as it is inBinancePlatform, whereREADME.zh-CN.mdis the Chinese translation of an English-primary doc). That's not the case here —AlpacaPlatform'sREADME.mdis already written entirely in Chinese, and has been since the initial commit (verified viagit log -p), authored directly by@Pigbibi, not a leftover from translation. Creating a "Chinese translation" of an already-Chinese file would just be a content duplicate, and adding a[English README](README.md)switcher link would mislabelREADME.mdas English when it isn't. Rather than guess at a restructuring that the task explicitly told me not to do (touch/reorganizeREADME.md), I'm flagging this for a maintainer decision — e.g. whether this repo should instead get an English translation (README.en.md?) withREADME.mdstaying canonical-Chinese, or whether the bilingual-pair convention simply doesn't apply to this repo. Happy to follow up once that's decided.Test plan
gh api repos/.../private-vulnerability-reportingthat the channel is disabled, soSECURITY.mddoesn't claim otherwise..github/workflows/ci.ymlrather than assuming BinancePlatform's.@Pigbibiis the actual repo author/committer viagit log.LICENSEtext against BinancePlatform's merged copy for an exact match.🤖 Generated with Claude Code