chore: complete open source project standards (LICENSE, CI, tests, community files)#3
Merged
chore: complete open source project standards (LICENSE, CI, tests, community files)#3
Conversation
Made-with: Cursor
Made-with: Cursor
P0 - Critical: - Add MIT LICENSE file - Add CI workflow with typecheck and API test steps P1 - Community: - Add CONTRIBUTING.md with dev setup, branch/commit conventions - Add SECURITY.md with vulnerability reporting process - Add .github/ISSUE_TEMPLATE/ (bug report + feature request + config) - Add .github/PULL_REQUEST_TEMPLATE.md P2 - Engineering quality: - Add api/tests/ with pytest suite (auth, upload, notebook, health) - Add api/requirements-dev.txt and pytest.ini - Add lint/lint:fix/format scripts to web/package.json - Add .github/dependabot.yml for npm, pip, and GitHub Actions P3 - Polish: - Add CHANGELOG.md following Keep a Changelog format - Add CODE_OF_CONDUCT.md (Contributor Covenant v2.1) - Add .github/workflows/release.yml for automated GitHub Releases on tags - Add .github/CODEOWNERS Made-with: Cursor
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.
Title:
chore: complete open source project standards (LICENSE, CI, tests, community files)Summary:
Summary
LICENSEfile to resolve legal ambiguity (README referenced it but file was missing).github/workflows/ci.ymlwith frontend typecheck + ESLint + API pytest pipeline as quality gate on every PRCONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.mdfor contributor onboarding.github/ISSUE_TEMPLATE/(bug report + feature request) andPULL_REQUEST_TEMPLATE.mdapi/tests/with pytest suite covering auth (JWT + endpoints), upload, notebook CRUD, and health check; addrequirements-dev.txtandpytest.inilint,lint:fix,formatscripts toweb/package.json.github/dependabot.ymlfor automated dependency updates (npm + pip + GitHub Actions)CHANGELOG.md(Keep a Changelog format),release.ymlworkflow for tag-based GitHub Releases, andCODEOWNERSTest plan
cd api && pip install -r requirements-dev.txt && pytest tests/ -vlocally and confirm all tests pass