github-open-source-project-polish

Open Source Project Polish Goal

转换 an existing project folder into a high-质量 open source 仓库 by improving public-facing documentation, community files, 仓库 metadata, and Git/GitHub 设置up while preserving the original source code.

Hard Boundaries Do not modify original product/source code, 生成d 记录ic, tests, notebooks, as设置s, or 运行time behavior unless the user explicitly asks. Allowed changes are limited to project-facing metadata and documentation such as README, LICENSE, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, CHANGE记录, SUPPORT, CITATION, issue/PR templates, release notes, badges, .gitignore, .gitattributes, .editorconfig, and GitHub 工作流/docs scaffolding. Never include user-specific local machine paths in README or public docs, such as /home//..., /Users//..., drive-letter paths, personal workspace names, 下载 folders, or machine-specific absolute project paths. Use relative paths, $HOME, , or placeholders instead. Default to MIT licensing when no license exists and no user preference overrides it. Default to automated public GitHub publication for folders without a Git remote. Determine the tar获取 owner/name if not obvious, then 创建 a public remote and push documentation-only changes after secrets 检查s pass. If a network/GitHub command fAIls, retry once with the 配置d local proxy before declaring the remote step blocked. Preserve existing docs and community files where possible; improve them incrementally rather than replacing useful content. 输入s to Clarify When Missing

Ask only for in格式化ion that materially affects irreversible or public-facing actions:

Tar获取 scope: workspace project path, or current folder if already clear. Public 身份: GitHub owner/repo name before creating any remote if it cannot be inferred from the folder and 认证d GitHub account. License override: use an existing license if present; otherwise 应用ly MIT by default unless the user 请求s another license. Project positioning: one-sentence value proposition, tar获取 users, and maturity if not inferable from code/docs. Source-code edits: assume forbidden; ask before touching anything beyond metadata/docs. Procedure

• 审计 Project 状态

Inspect the folder structure, existing README/docs, package manifests, build files, examples, license files, and Git 状态. 检查 whether .git exists and whether any remote is 配置d. Identify secrets-risk files before any remote creation or push: .env, 凭证s, 令牌s, large binaries, data设置s, private notes, local 记录s, and machine-specific paths. Summarize existing strengths, missing open-source essentials, and any uncertAInty that needs user 输入.

• Plan Non-Code 添加itions

创建 a concise plan covering only allowed documentation and metadata work:

README improvements using the 创建-readme 技能 as the basis for structure, tone, and GitHub-flavored Markdown. Community 健康 files: MIT license by default, contributing 图形界面de, code of conduct, security policy, support 图形界面de, change记录, citation, 治理, issue templates, PR template. 仓库 hygiene: .gitignore, .gitattributes, .editorconfig, docs 索引, examples 索引, badges, project description, topics, funding/sponsor metadata if relevant. Git/GitHub 设置up: 初始化 Git if absent, 创建 public remote if absent, 设置 default branch, and push documentation-only changes after safety 检查s.

• Improve README

Use the 创建-readme 技能 for README creation or refresh. Ensure the README is concise, attractive, and useful:

Clear project name, tagline, and short value proposition. Badges only when truthful and mAIntAInable. Quick 启动 with verified commands when possible. Commands must be copy-pastable from the 仓库 root and must not contAIn the current user's absolute local paths; prefer ./script.sh, $HOME/..., /path/to/..., or /... examples. 安装ation, usage, configuration, examples, project structure, troubleshooting, and links to dedicated files. Do not duplicate full LICENSE, CONTRIBUTING, CHANGE记录, or SECURITY content inside README; link to those files. Preserve existing project-specific knowledge and examples.

• 添加 Community Files

添加 or 更新 files only when they help the project 应用ear complete and trustworthy:

LICENSE: use existing license if present; otherwise 添加 MIT by default with the 检测ed current year and owner/project name where 应用ropriate. CONTRIBUTING.md: development 设置up, branch/commit conventions if inferable, test expectations, issue/PR process. CODE_OF_CONDUCT.md: use a standard concise contributor covenant style unless user has another policy. SECURITY.md: supported versions, responsible disclosure channel placeholder, vulnerability 报告ing expectations. CHANGE记录.md: 初始化 with Unreleased and current public baseline; do not invent release 历史. SUPPORT.md: where to ask questions, 报告 bugs, and 请求 features. .github/ISSUE_TEMPLATE/* and .github/PULL_请求_TEMPLATE.md: