Establish MIT OSS governance, CI, and Codex maintenance plan#22
Merged
Conversation
…for OSS. Add license and community health docs, CI/Dependabot, a public Codex maintenance plan and roadmap, safe env defaults, and a clearer README so reviewers can assess governance and intended credit use. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Pull request overview
Establishes an MIT-licensed open-source governance and maintenance baseline for Globot, adding community health documentation and GitHub automation while updating defaults and setup guidance for safer OSS review.
Changes:
- Adds MIT
LICENSEplus community health / governance docs (CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, GOVERNANCE, SUPPORT) and maintainer plans underdocs/. - Introduces GitHub automation: CI workflow, Dependabot config, issue/PR templates, and CODEOWNERS.
- Updates README, backend defaults, and
.env.examplefiles to remove personal/admin defaults and clarify safe configuration.
Reviewed changes
Copilot reviewed 24 out of 27 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| SUPPORT.md | Adds support channels and expectations for community requests. |
| SECURITY.md | Defines vulnerability reporting process and security boundaries. |
| README.md | Rewrites OSS-facing overview, quick start, and project health sections. |
| LICENSE | Adds MIT license text for OSI-approved licensing. |
| GOVERNANCE.md | Documents maintainer role and decision-making process. |
| frontend/pnpm-workspace.yaml | Adds pnpm workspace/build allowlist configuration (needs adjustments noted in comments). |
| frontend/pnpm-lock.yaml | Updates lockfile content consistent with frontend dependency state. |
| frontend/package.json | Renames frontend package and removes pnpm override block (version alignment issue noted). |
| frontend/.env.example | Adds API base URL example (path alignment issue noted). |
| docs/ROADMAP.md | Adds public roadmap to guide contributor priorities. |
| docs/OPENAI_API_PLAN.md | Adds concrete maintainer plan for OpenAI/Codex credit usage and guardrails. |
| CONTRIBUTING.md | Adds contribution workflow and expectations. |
| CODE_OF_CONDUCT.md | Adds Contributor Covenant-based community standards. |
| CHANGELOG.md | Adds changelog scaffold and records notable changes. |
| backend/Dockerfile | Aligns backend container base image to Python 3.11. |
| backend/config.py | Removes personal admin whitelist default; turns debug off by default; renames default DB name. |
| backend/.env.example | Adds safe example environment variables with empty credential defaults. |
| AGENTS.md | Adds guidance for automated agent contributions and required checks. |
| .gitignore | Removes overly broad markdown/txt ignore rules to allow new community docs. |
| .github/workflows/ci.yml | Adds CI for backend compile and frontend build (env alignment issue noted). |
| .github/pull_request_template.md | Adds PR template with validation and safety checklist. |
| .github/ISSUE_TEMPLATE/feature_request.yml | Adds feature request issue template. |
| .github/ISSUE_TEMPLATE/config.yml | Disables blank issues and adds security/support contact links. |
| .github/ISSUE_TEMPLATE/bug_report.yml | Adds bug report template emphasizing reproducibility and safety. |
| .github/dependabot.yml | Adds weekly Dependabot updates for pip, npm, and GitHub Actions. |
| .github/CODEOWNERS | Adds CODEOWNERS defaulting reviews to the maintainer. |
Files not reviewed (1)
- frontend/pnpm-lock.yaml: Generated file
Comments suppressed due to low confidence (1)
.github/workflows/ci.yml:45
- CI sets
VITE_API_BASE_URLtohttp://localhost:8000, which is inconsistent with the frontend service paths that assume an/apibase (e.g.,${baseURL}/v2/...). Aligning this with the app’s/apiprefix avoids accidentally baking an incorrect base into built assets.
env:
VITE_CLERK_PUBLISHABLE_KEY: pk_test_ci_placeholder
VITE_API_BASE_URL: http://localhost:8000
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+68
to
+72
| python -m venv .venv | ||
| # Windows PowerShell | ||
| .\.venv\Scripts\Activate.ps1 | ||
| # macOS/Linux | ||
| # source .venv/bin/activate |
| @@ -1,2 +1,3 @@ | |||
| # Clerk Configuration | |||
| VITE_CLERK_PUBLISHABLE_KEY=pk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |||
| VITE_API_BASE_URL=http://localhost:8000 | |||
Comment on lines
+1
to
+8
| # pnpm 11+ settings (package.json "pnpm" field is ignored in v11) | ||
| overrides: | ||
| vite: 6.3.5 | ||
|
|
||
| allowBuilds: | ||
| esbuild: true | ||
| '@clerk/shared': true | ||
| '@tailwindcss/oxide': true |
Comment on lines
105
to
+109
| "react-dom": { | ||
| "optional": true | ||
| } | ||
| }, | ||
| "pnpm": { | ||
| "overrides": { | ||
| "vite": "6.3.5" | ||
| } | ||
| } | ||
| } No newline at end of file | ||
| } |
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
Test plan
python -m compileall -q backendcd frontend && pnpm install && pnpm build