本地开发

我们欢迎各种贡献,无论大小。本指南将帮助你入门。

📜 行为守则

我们遵循一份 行为守则 以营造一个开放且热情的社区。参与即表示您同意遵守这些标准。


🤝 贡献方式

以下是您可以帮助改进 CheckCle 的一些方式:

  • 🐞 报告错误 – 发现故障?通过打开一个 GitHub 问题.

  • 🌟 提出功能建议 – 有想法吗?开启一个 讨论 或打开一个功能请求问题。

  • 🛠 提交拉取请求 – 改进代码、修复错误、添加功能或增强文档。

  • 📝 改进文档 – 即使是修正一个拼写错误也有帮助!

  • 🌍 传播项目 – 给仓库加星 ⭐,在社交平台分享,并邀请他人参与贡献!


🧰 开发环境设置

在贡献代码之前,请在本地设置项目:

1. Fork 仓库

GitHub 上点击“Fork”以创建您自己的副本。

2. 克隆您的 Fork

git clone https://github.com/yourusername/checkcle.git
cd checkcle

3. 安装依赖

按照自述文件或项目文档中的说明安装所需包并运行本地开发服务器。

4. 启动本地开发

#Web 应用
cd application/ 
npm install && npm run dev

#服务器后端
cd server
./pocketbase serve --dir pb_data 

如果您不使用 localhost,请使用此命令运行(./pocketbase serve --http=0.0.0.0:8090 --dir pb_data)。

4. 启动服务检查操作

#服务器后端 
启动服务操作(检查 PING、HTTP、TCP、DNS 服务)

cd server/service-operation

go run main.go(当连接为 localhost 时,您无需更改 .env)

5. 启动分布式区域代理

#### 1. Fork 仓库
在 [GitHub](https://github.com/operacle/Distributed-Regional-Monitoring) 上点击“Fork”以创建您自己的副本。

#### 2. 克隆您的 Fork
git clone --branch main https://github.com/operacle/Distributed-Regional-Monitoring.git
cd Distributed-Regional-Monitoring

#### 3. 安装 Go 服务(确保您已安装 Go)

复制 .env.example -> .env
在 .env 文件中更改区域代理配置
然后运行:go run main.go

✅ 拉取请求流程

  1. 确保您的代码遵循现有的风格和命名约定。

  2. 编写清晰简洁的提交信息。

  3. 推送您的分支并在 develop 分支上打开一个拉取请求(PR)。

  4. 提供有意义的 PR 描述(是什么/为什么/如何)。

  5. 如适用,请关联相关问题(例如, 关闭 #12).

  6. 确保所有检查通过(例如,代码风格检查、测试)。

我们会审核您的 PR,必要时请求更改,并在准备就绪后合并!


🐛 报告错误与问题

请尽可能提供详细信息:

  • 一个清晰、描述性的标题

  • 重现步骤

  • 预期行为与实际行为

  • 环境信息(操作系统、浏览器、设备等)

  • 如适用,请提供截图或日志

使用 问题跟踪器 用于报告。


💡 功能请求

我们很乐意听取您的想法!开启一个 讨论 或功能请求问题。确保它尚未在 路线图.

最后更新于