mcpField
S
ShareX Core Standards

ShareX Core Standards

github.com/sharex开发34262 次安装今天更新
代码仓库

关于 ShareX Core Standards

ShareX Core Standards 是面向 ShareX Avalonia 实现贡献者的仓库编码技能，涵盖代码、构建、测试、文档和安全要求。

主要功能

  1. 01C# 许可证头要求
  2. 02Windows 目标框架规范
  3. 03SkiaSharp 中央版本管理
  4. 04构建与测试要求
  5. 05文档和安全规则

适用场景

  1. 01新增或编辑 C# 文件
  2. 02配置面向 Windows 的项目
  3. 03完成前检查代码更改

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/sharex/xerahs --skill sharex-core-standards

安装后在 Claude Code 中输入/sharex-core-standards确认已加载。

详细介绍

许可证标头要求

在此仓库中创建或编辑 C# 文件（.cs）时，请在文件顶部添加以下许可证标头（针对 Avalonia 实现进行调整）：

#region License Information (GPL v3)

/*
    XerahS - The Avalonia UI implementation of ShareX
    Copyright (c) 2007-2026 ShareX Team

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation; either version 2
    of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    Optionally you can also view the license at <http://www.gnu.org/licenses/>.
*/

#endregion License Information (GPL v3)

构建配置规则

Windows 目标框架名称（TFM）

重要：配置项目以 Windows 为目标时，请使用包含平台版本的显式 TFM 格式： net10.0-windows10.0.26100.0

不要使用： <TargetFramework>net10.0-windows</TargetFramework> 并另外设置 <TargetPlatformVersion>... 属性。 这是为了避免在使用 CsWinRT 完整构建解决方案时出现“未提供 Windows 元数据”错误。

SkiaSharp 版本指南

重要： SkiaSharp 由根目录下的 Directory.Packages.props 集中管理；请确保托管包和原生包使用相同的当前版本。

  • 在新项目中添加 SkiaSharp 时，优先使用共享的集中包版本，而不是引入项目本地的内联版本。
  • 如果遇到版本冲突，请与根目录中的集中包管理条目保持一致，而不要重新引入旧版 2.88.9 固定版本。
  • 此指南适用于所有项目，包括 XerahS.* 和 ShareX.ImageEditor。

通用编码规则

代码和配置变更
  • 遵循各项目区域中的现有模式。
  • 变更应尽量精简且有针对性。
  • 仅在必要时添加简短注释，以解释不明显的逻辑。
  • 重要： 修改代码后，务必运行 dotnet build，并在完成前修复所有构建错误。
  • 有关 Git 工作流、提交格式和版本号变更行为，请遵循 .ai/skills/git-workflow/SKILL.md。
  • 确保代码能够编译；如果不能，请修复问题。 这是完成任何编码任务前的强制检查。
变更安全
  • 不要删除或重写无关内容。
  • 仅通过 .ai/skills/git-workflow/SKILL.md 中定义的工作流应用版本变更。
  • 如果需求含糊，请明确指出所采用的假设。
测试
  • 如果修改了可执行代码，请建议相关测试。
  • 如果添加测试，请遵循当前的测试约定。
文档
  • 如果行为或用法发生变化，请更新或添加文档。
  • 文件名和标题应清晰且保持稳定。
  • 技术文档位置：所有不适合放在其他特定 docs/ 子文件夹中的技术 .md 文件，都应自动保存到 docs/technical。不要将其保存在根目录。
  • 文档的提交要求请遵循 .ai/skills/git-workflow/SKILL.md。
安全
  • 不要包含机密信息或令牌。
  • 示例中应避免记录敏感数据。
输出格式
  • 对变更内容及其位置进行总结。
  • 仅在下一步操作自然且可执行时提供建议。

评论

支持 Markdown