Contributing to dsh-memory-plugin

August 20, 2026 · View on GitHub

欢迎贡献！以下是参与项目的一些指南。

🚀 开始贡献

  1. Fork 本仓库
  2. 创建你的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交你的改动 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 开启一个 Pull Request

📝 代码规范

  • 使用 JSDoc 注释所有公共 API
  • 保持代码简洁易读
  • 添加适当的错误处理
  • 编写测试用例

🧪 测试

运行测试：

npm test

📄 文档

  • 更新 README.md 以反映任何变化
  • 为新功能添加示例
  • 保持文档最新

🐛 报告问题

如果你发现 bug，请：

  1. 检查是否已有相同问题
  2. 提供详细的复现步骤
  3. 说明预期行为和实际行为
  4. 包含环境信息（Node.js 版本、操作系统等）

💡 功能建议

欢迎提出新功能建议！请说明：

  • 功能的用途和价值
  • 可能的实现方式
  • 与其他功能的关系

📜 许可证

通过贡献代码，你同意你的贡献将在 MIT 许可证下发布。

感谢你的贡献！🎉