docs: 修复了贡献文档,重新对 README 排版
This commit is contained in:
@@ -1,6 +1,15 @@
|
|||||||
# OUC Server 
|
# OUC Server
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="docs/爱特logo.svg" width=100/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="docs/Organization-ITstudio-shield.svg"/>
|
||||||
|
<img src="https://img.shields.io/badge/Language-C++17-blue">
|
||||||
|
<img src="https://img.shields.io/badge/Package-CMake-red">
|
||||||
|
</div>
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
本项目由中国海洋大学爱特工作室组织开发,目标是基于 Linux 构建一个 **高性能、可扩展的现代 C++ HTTP 网络编程库**,为学习和实践网络编程提供平台,同时探索事件驱动架构、异步 I/O、协议封装等关键技术。
|
本项目由中国海洋大学爱特工作室组织开发,目标是基于 Linux 构建一个 **高性能、可扩展的现代 C++ HTTP 网络编程库**,为学习和实践网络编程提供平台,同时探索事件驱动架构、异步 I/O、协议封装等关键技术。
|
||||||
|
|
||||||
@@ -9,7 +18,7 @@
|
|||||||
- 提供简洁易用的 **Socket 封装** 接口
|
- 提供简洁易用的 **Socket 封装** 接口
|
||||||
- 支持 **多路复用**(epoll/kqueue等)
|
- 支持 **多路复用**(epoll/kqueue等)
|
||||||
- 内置 **事件循环** 与 **任务调度**
|
- 内置 **事件循环** 与 **任务调度**
|
||||||
- 扩展常用协议(HTTP、WebSocket等)
|
- 封装常用协议(HTTP、WebSocket等)
|
||||||
- 作为教学和研究平台,便于社团成员学习与贡献
|
- 作为教学和研究平台,便于社团成员学习与贡献
|
||||||
|
|
||||||
## 🚀 快速开始
|
## 🚀 快速开始
|
||||||
@@ -34,7 +43,7 @@ make -j4
|
|||||||
### 📖 运行示例
|
### 📖 运行示例
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./examples
|
./example
|
||||||
```
|
```
|
||||||
|
|
||||||
### 📂 仓库结构
|
### 📂 仓库结构
|
||||||
@@ -43,7 +52,7 @@ make -j4
|
|||||||
ouc_server
|
ouc_server
|
||||||
├── include/ # 公共头文件
|
├── include/ # 公共头文件
|
||||||
├── src/ # 源代码
|
├── src/ # 源代码
|
||||||
├── examples/ # 示例程序
|
├── example/ # 示例程序
|
||||||
├── tests/ # 单元测试
|
├── tests/ # 单元测试
|
||||||
├── docs/ # 文档
|
├── docs/ # 文档
|
||||||
├── CMakeLists.txt
|
├── CMakeLists.txt
|
||||||
@@ -55,7 +64,7 @@ ouc_server
|
|||||||
我们欢迎任何形式的贡献!
|
我们欢迎任何形式的贡献!
|
||||||
|
|
||||||
1. Fork 本仓库
|
1. Fork 本仓库
|
||||||
2. 从 dev 分支新建功能分支 feature/...
|
2. 从 `dev` 分支新建功能分支 `feature/...`
|
||||||
3. 提交 Pull Request,并等待 Review
|
3. 提交 Pull Request,并等待 Review
|
||||||
4. 通过 CI 检查和 Review 后合并到主仓库
|
4. 通过 CI 检查和 Review 后合并到主仓库
|
||||||
|
|
||||||
@@ -74,4 +83,5 @@ ouc_server
|
|||||||
哈哈,没写
|
哈哈,没写
|
||||||
|
|
||||||
## 📜 许可证
|
## 📜 许可证
|
||||||
|
|
||||||
本项目采用 [MIT License](/LICENSE) 开源。
|
本项目采用 [MIT License](/LICENSE) 开源。
|
||||||
@@ -75,18 +75,16 @@
|
|||||||
|
|
||||||
## 🎨 代码风格
|
## 🎨 代码风格
|
||||||
|
|
||||||
- 使用 **C++17** 标准。
|
详见 [代码规范](code_style.md)
|
||||||
- 缩进统一为 **4 空格**。
|
|
||||||
- 文件名统一小写,单词用下划线分隔(如 `event_loop.h`)。
|
|
||||||
- 类名采用 **大驼峰命名**(如 `EventLoop`)。
|
|
||||||
- 函数与变量采用 **小写加下划线**(如 `start_server()`,`buffer_size`)。
|
|
||||||
- 公共接口需要写清楚 **Doxygen 风格注释**。
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🔍 Code Review 原则
|
## 🔍 Code Review 原则
|
||||||
|
|
||||||
详见 [代码规范](code_style.md)
|
- 确认代码可读、可维护,避免冗余实现。
|
||||||
|
- 注意异常处理、内存管理和线程安全问题。
|
||||||
|
- 保证接口一致性和合理性。
|
||||||
|
- 审查通过后,才能合并到 `dev` 分支。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
+8
-6
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
- 使用 **C++17** 或更高版本。
|
- 使用 **C++17** 或更高版本。
|
||||||
- 优先使用标准库功能,避免非必要的第三方依赖。
|
- 优先使用标准库功能,避免非必要的第三方依赖。
|
||||||
- 引入第三方依赖时,若有 CMake 或 Github 仓库时应避免直接复制文件于本项目。
|
- 引入第三方依赖时,若有 CMake 或 Github 仓库时应避免 **直接复制文件于本项目**。
|
||||||
|
|
||||||
## 2. 文件与目录命名
|
## 2. 文件与目录命名
|
||||||
|
|
||||||
@@ -126,7 +126,7 @@
|
|||||||
```cpp
|
```cpp
|
||||||
int sum = a + b;
|
int sum = a + b;
|
||||||
```
|
```
|
||||||
- 控制语句中除单语句及 `do while` 外均需要添加大括号作用域:
|
- 控制语句中除单语句及 `do while` 外均需要 **添加大括号作用域**:
|
||||||
- 条件分支
|
- 条件分支
|
||||||
```cpp
|
```cpp
|
||||||
// Wrong!
|
// Wrong!
|
||||||
@@ -212,18 +212,20 @@
|
|||||||
3. 第三方库头文件
|
3. 第三方库头文件
|
||||||
4. 其他模块头文件
|
4. 其他模块头文件
|
||||||
|
|
||||||
|
模块内部的头文件应当利用 CMake 配置后 **使用尖括号而非双引号** 包含。
|
||||||
|
|
||||||
示例:
|
示例:
|
||||||
```cpp
|
```cpp
|
||||||
#include "tcp_server.hpp"
|
#include <server/tcp_server.hpp>
|
||||||
|
|
||||||
#include <vector>
|
#include <vector>
|
||||||
#include <string>
|
#include <string>
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
|
|
||||||
#include "third_party/some_c_lib.h"
|
#include <third_party/some_c_lib.h>
|
||||||
#include "third_party/some_cpp_lib.hpp"
|
#include <third_party/some_cpp_lib.hpp>
|
||||||
|
|
||||||
#include "event_loop.hpp"
|
#include <event/event_loop.hpp>
|
||||||
```
|
```
|
||||||
|
|
||||||
## 10. 测试与调试
|
## 10. 测试与调试
|
||||||
|
|||||||
Reference in New Issue
Block a user