소스 검색

更新文档并添加与GitHub Wiki的引用说明

在README.md、SECURITY.md、CONTRIBUTING.md、CONTRIBUTORS.md和CHANGELOG.md中增加了提示,指出如果这些文档内容与GitHub Wiki上的内容有冲突时,应以Wiki为准。同时,在CHANGELOG.md中记录了新增文件及对现有文件的一些修改。
SongZihuan 1 주 전
부모
커밋
bab6d64472
5개의 변경된 파일28개의 추가작업 그리고 1개의 파일을 삭제
  1. 17 0
      CHANGELOG.md
  2. 2 0
      CONTRIBUTING.md
  3. 5 1
      CONTRIBUTORS.md
  4. 2 0
      README.md
  5. 2 0
      SECURITY.md

+ 17 - 0
CHANGELOG.md

@@ -5,6 +5,23 @@
 其格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.1.0/),
 且本项目遵循 [语义化版本控制](https://semver.org/lang/zh-CN/)。
 
+**注意:本文档内容若与[GitHub Wiki](https://github.com/SongZihuan/BackendServerTemplate/wiki/%E5%8F%98%E6%9B%B4%E6%97%A5%E5%BF%97)冲突,则以后者为准**
+
+## [0.5.0] - 2025-04-19
+
+### 新增
+
+- 新增`SECURITY.md`、`CONTRIBUTORS.md`和`CONTRIBUTING.md`。
+- 为一些文档添加了`Wiki`引用。
+
+### 变更
+
+- 简单修改了一下`README.md`。
+- 提供了参考性的`MIT LICENSE`翻译。
+- 为部分文件添加遗漏的版权声明。
+- 服务描述限制为一行。
+- 语义化版本号中的构建信息部分,使用`.`作为分隔符(原使用`-`作为分隔符)。
+
 ## [0.4.6] - 2025-04-19
 
 ### 新增

+ 2 - 0
CONTRIBUTING.md

@@ -2,6 +2,8 @@
 
 首先,感谢您考虑为本项目做出贡献!我们非常欢迎并珍视来自社区的每一份贡献。无论是代码提交、文档更新还是问题报告,您的参与都是对我们最大的支持。
 
+**注意:本文档内容若与[GitHub Wiki](https://github.com/SongZihuan/BackendServerTemplate/wiki/%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)冲突,则以后者为准**
+
 ## 如何做出贡献
 
 ### 修复Bug

+ 5 - 1
CONTRIBUTORS.md

@@ -1,6 +1,10 @@
 # 贡献者名单
 
-我们衷心感谢所有为本项目做出贡献的人!以下是按字母顺序排列的贡献者名单(排名不分先后):
+我们衷心感谢所有为本项目做出贡献的人!
+
+**注意:本文档内容若与[GitHub Wiki](https://github.com/SongZihuan/BackendServerTemplate/wiki/%E8%B4%A1%E7%8C%AE%E8%80%85)冲突,则以后者为准**
+
+以下是按字母顺序排列的贡献者名单(排名不分先后):
 
 - **总贡献**
   - [@SongZihuan](https://github.com/SongZihuan)

+ 2 - 0
README.md

@@ -2,6 +2,8 @@
 
 使用 `Golang` 实现的后端服务模板程序。
 
+**注意:本文档内容若与[GitHub Wiki](https://github.com/SongZihuan/BackendServerTemplate/wiki/%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B)冲突,则以后者为准**
+
 ## 介绍
 
 本模板程序旨在实现一个 `Golang` 的后端服务,可以是 `Http` 也可以是其他。为了完成这个目的,我设计了一部分基础套件。

+ 2 - 0
SECURITY.md

@@ -2,6 +2,8 @@
 
 我们非常重视本项目的安全性。如果您发现了任何潜在的安全漏洞,请按照以下步骤报告。
 
+**注意:本文档内容若与[GitHub Wiki](https://github.com/SongZihuan/BackendServerTemplate/wiki/%E5%AE%89%E5%85%A8%E7%AD%96%E7%95%A5)冲突,则以后者为准**
+
 ## 如何报告漏洞
 
 ### 严重漏洞问题