Code-MCP

{ "github": { "repository": { "essentialFiles": [ { "file": "README.md", "purpose": "Project overview, installation, usage", "required": true, "tips": [ "Add badges for build status, version, license", "Include clear installation instructions", "Add screenshots or GIFs for visual projects", "Keep it concise but comprehensive" ] }, { "file": "LICENSE", "purpose": "Legal terms for usage", "required": true, "popular": [ "MIT", "Apache-2.0", "GPL-3.0", "BSD-3-Clause" ] }, { "file": ".gitignore", "purpose": "Exclude files from version control", "required": true, "resources": [ "gitignore.io", "github/gitignore" ] }, { "file": "CONTRIBUTING.md", "purpose": "Guidelines for contributors", "required": false }, { "file": "CODE_OF_CONDUCT.md", "purpose": "Community behavior expectations", "required": false }, { "file": "SECURITY.md", "purpose": "Security vulnerability reporting", "required": false }, { "file": "CHANGELOG.md", "purpose": "Track version changes", "format": "Keep a Changelog" }, { "file": "FUNDING.yml", "location": ".github/FUNDING.yml", "purpose": "Sponsor button configuration" } ], "specialDirectories": [ { "path": ".github/", "purpose": "GitHub-specific configurations" }, { "path": ".github/workflows/", "purpose": "GitHub Actions CI/CD" }, { "path": ".github/ISSUE_TEMPLATE/", "purpose": "Issue templates" }, { "path": ".github/PULL_REQUEST_TEMPLATE/", "purpose": "PR templates" }, { "path": "docs/", "purpose": "Documentation files" } ] }, "badges": { "shields.io": [ "", "", "", "", "", "", "", "" ], "custom": [ "", "", "" ] }, "actions": { "popularActions": [ { "name": "actions/checkout@v4", "purpose": "Check out repository code" }, { "name": "actions/setup-node@v4", "purpose": "Set up Node.js environment" }, { "name": "actions/setup-python@v5", "purpose": "Set up Python environment" }, { "name": "actions/cache@v4", "purpose": "Cache dependencies" }, { "name": "actions/upload-artifact@v4", "purpose": "Upload build artifacts" }, { "name": "actions/download-artifact@v4", "purpose": "Download artifacts" }, { "name": "actions/dependency-review-action@v4", "purpose": "Security review of dependencies" }, { "name": "peaceiris/actions-gh-pages@v4", "purpose": "Deploy to GitHub Pages" }, { "name": "docker/build-push-action@v5", "purpose": "Build and push Docker images" } ], "triggers": [ "push", "pull_request", "schedule", "workflow_dispatch", "release", "issues", "issue_comment", "fork", "watch" ] }, "pages": { "staticSiteGenerators": [ { "name": "Jekyll", "builtin": true, "config": "_config.yml" }, { "name": "Next.js", "command": "npx create-next-app", "export": "next export" }, { "name": "Vite", "command": "npm create vite@latest", "base": "Configure base in vite.config.js" }, { "name": "Docusaurus", "command": "npx create-docusaurus@latest", "purpose": "Documentation sites" }, { "name": "VitePress", "command": "npm add -D vitepress", "purpose": "Vue-powered docs" }, { "name": "Astro", "command": "npm create astro@latest" }, { "name": "Hugo", "command": "hugo new site", "fast": true }, { "name": "MkDocs", "command": "pip install mkdocs-material", "purpose": "Python documentation" } ], "themes": { "jekyll": [ "minima", "just-the-docs", "minimal-mistakes", "cayman" ], "docsify": [ "vue", "buble", "dark", "pure" ] }, "customDomain": { "steps": [ "Add CNAME file with your domain", "Configure DNS A records to GitHub IPs", "Enable HTTPS in repository settings" ], "githubIPs": [ "185.199.108.153", "185.199.109.153", "185.199.110.153", "185.199.111.153" ] } }, "features": { "discussions": { "purpose": "Community Q&A and announcements", "categories": [ "Announcements", "General", "Ideas", "Q&A", "Show and Tell" ] }, "projects": { "purpose": "Kanban-style project management", "views": [ "Board", "Table", "Roadmap" ] }, "releases": { "purpose": "Version management with changelogs", "autoGenerate": true, "assets": "Attach binaries and artifacts" }, "wiki": { "purpose": "Documentation wiki", "git": "Separate git repository" }, "codespaces": { "purpose": "Cloud development environments", "config": ".devcontainer/devcontainer.json" }, "dependabot": { "purpose": "Automated dependency updates", "config": ".github/dependabot.yml" }, "secretScanning": { "purpose": "Detect leaked credentials", "automatic": true }, "codeScanning": { "purpose": "Security vulnerability detection", "tool": "CodeQL" } }, "socialPreview": { "size": "1280x640px", "format": "PNG or JPG", "location": "Settings > General > Social preview" } } }