Przeglądaj źródła

更新README并添加安全与贡献指南

修改了README.md的标题以更好地反映内容,并新增了SECURITY.md和CONTRIBUTING.md文件,分别详细说明了如何报告安全漏洞及为项目贡献的方法。这些文档旨在增强项目的透明度、安全性和社区参与度。
SongZihuan 1 tydzień temu
rodzic
commit
a12016479f
3 zmienionych plików z 104 dodań i 1 usunięć
  1. 42 0
      CONTRIBUTING.md
  2. 1 1
      README.md
  3. 61 0
      SECURITY.md

+ 42 - 0
CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Golang 后端服务 模板程序 - 贡献指南
+
+首先,感谢您考虑为本项目做出贡献!我们非常欢迎并珍视来自社区的每一份贡献。无论是代码提交、文档更新还是问题报告,您的参与都是对我们最大的支持。
+
+## 如何做出贡献
+
+### 修复Bug
+
+如果您发现了一些Bug,建议您先浏览[Issue](https://github.com/SongZihuan/BackendServerTemplate/issues),看看是否有类似问题,和解决方案。
+
+更加具体的**Bug报告**要求请参考本项目的 [安全策略](SECURITY.md) 。
+
+### 功能添加
+
+如果您为项目添加了新功能,我们非常欢迎。但出于各种原因,新功能获取不能被采纳,我们对这点深表惋惜。不过您仍然可以将本项目进行`Fork`,然后应用您的更新。
+或许一段时间后,或许我们能重新采纳您的新功能。
+
+**注意:本项目是模板Golang项目,不具备实际业务,因此不接受数据库系统、缓存系统、HTTP系统服务、TCP系统服务等相关功能的引入。可以参考我另一个由此项目延伸开发案的HTTP服务系统项目模板。**
+
+### 文档等修缮
+
+如果您认为文档有错误,建议您直接提交[Issue](https://github.com/SongZihuan/BackendServerTemplate/issues),工作人员查明后进行更正。
+此处的文档指:根目录下的`README.md`等文档,以及位于项目`Github Wiki`的文档。
+
+### 代码注释修缮
+
+若您认为代码中存在含糊不清的注释或缺失应有注释,你可以直接提交[Issue](https://github.com/SongZihuan/BackendServerTemplate/issues),或提交直接提交[PR](https://github.com/SongZihuan/BackendServerTemplate/pulls)。
+
+## 代码风格约束
+
+1. 新建的`.go`文件需包含版权声明头部:
+    ```go
+    // Copyright 2025 BackendServerTemplate Authors. All rights reserved.
+    // Use of this source code is governed by a MIT-style
+    // license that can be found in the LICENSE file.
+    
+    package xxx
+    ```
+
+2. 请先阅读`Wiki`,明白各包的作用和相互依赖关系,避免造成以来混乱。
+3. 本项目仅是一个模板项目,不具与实际业务。
+4. 请编写合适的单元测试,并且提交`PR`后由`GitHub Action`进行测试。

+ 1 - 1
README.md

@@ -1,4 +1,4 @@
-# Golang 后端服务 模板程序 - 简单版
+# Golang 后端服务 模板程序 - 介绍
 
 使用 `Golang` 实现的后端服务模板程序。
 

+ 61 - 0
SECURITY.md

@@ -0,0 +1,61 @@
+# Golang 后端服务 模板程序 - 安全策略
+
+我们非常重视本项目的安全性。如果您发现了任何潜在的安全漏洞,请按照以下步骤报告。
+
+## 如何报告漏洞
+
+### 严重漏洞问题
+
+所谓严重漏洞问题,即不建议采用公开方式进行披露的问题。若将问题直接公开披露,可能会导致本开发团队在修复问题前,被恶意用户收集并利用,从而造成其他损失。
+
+例如:通过某一手段可以实现SQL注入攻击的、通过某一手段可改变程序运行的完整性的、通过某一手段可实现内存攻击的。
+
+一般问题,例如:拼写错误。
+
+### 公开问题披露
+
+可使用Issues:[Github Issues](https://github.com/SongZihuan/BackendServerTemplate/issues)
+
+**注意:请保护好个人隐私。**
+
+**注意:严重漏洞问题请采用非公开问题披露方式,若您无法确定问题的严重程度可一律采取非龚刚开问题披露方式。**
+
+### 非公开问题披露
+
+作者:宋子桓(Song Zihuan),或称 Cr.Huan 。
+作者邮箱(接收问题披露):[contact@song-zh.com](mailto://contact@song-zh.com)。
+作者网上留言(接收问题披露):[song-zh.com/message](https://song-zh.com/message),请务必告知您的回访联系方式。
+
+我们预估会在 **48-72 小时内** 给予您回复,并开始调查问题。
+
+**注意:若确定为严重漏洞问题的,并满足以下条件的披露者可获得20元以上的奖励(上不封顶)。**
+
+1. 问题未被开发团队收集,并着手准备处理。
+2. 问题未造成实际上的严重影响。
+3. 仅使用上述非公开问题披露方式向我们披露问题,未在其他渠道披露问题的。
+4. 问题最终能够被解决的。
+5. 项目当前仍在活跃更新的。
+6. 问题通过本次披露后被受理的。
+7. 无其他争议的。
+
+## 支持的版本
+
+我们采用语义化版本号进行版本标识。
+
+我们只受理以下版本的问题:
+
+1. 最新版本(主版本号、次版本号、补丁版本号均为最新)。
+2. 最新版本的主版本号小1的旧主版本系列对应的最新版本,但非长期支持。
+
+例如:最新版本号为v2.0.0,那最新版本的主版本号小1的旧主版本号则为0,那么可能会对1.x.x系列最新版本继续一段时间的支持。
+
+每次安全漏洞修复会递增补丁版本号,生成新的版本,随后旧版本将不再被支持。
+
+## 安全更新流程
+
+一旦确认漏洞,我们将采取以下步骤:
+
+1. 验证漏洞的严重性和影响范围。
+2. 开发修复补丁。
+3. 在必要时通知关键用户和合作伙伴。
+4. 发布修复版本,并公开披露漏洞详情(在适当的情况下)。