CONTRIBUTING.md

Contributing to XingRin

感谢你愿意为 XingRin 做出贡献。

贡献方式

• 提交 Bug 报告
• 提出功能建议或产品想法
• 改进文档、安装流程和示例
• 提交代码修复或新功能 Pull Request

开始之前

在开始较大改动前，建议先创建 Issue 说明背景、目标和实现方向，避免重复工作。

对于小修复、文档修正和明显 Bug，也欢迎直接提交 Pull Request。

Pull Request 建议

• 保持改动聚焦，避免把无关修改混在一个 PR 中
• 尽量补充必要的说明、截图或复现步骤
• 如果涉及安全相关行为，请明确测试范围和授权前提
• 与现有代码风格、命名和目录结构保持一致

Issue 建议

提交 Issue 时，建议附上：

• 使用场景
• 复现步骤
• 实际结果与预期结果
• 日志、截图或错误信息
• 运行环境信息

许可证约定

提交 Pull Request 即表示你确认：

• 你有权提交这些代码、文档或资源
• 你的贡献将以本仓库当前使用的 MIT License 发布

社区协作

参与社区前，请先阅读 Code of Conduct。

感谢你的时间、想法和贡献。