study_xxqg/docs/contribute.md

study_xxqg作为一个开源程序，欢迎大家尽自己的一份力做出贡献

贡献要求

• 热爱祖国

• 愿意参与开源贡献

贡献文档

文档采用docsify框架加上github page进行自动部署，

你只需要在docs目录进行marikdown编写，提交pr后会

自动生成，本地可通过docsify进行查看运行结果

贡献代码

技术需求

项目采用go语言编写
web框架采用gin框架
爬虫框架采用req库
浏览器自动化框架采用playwright-go库

目录结构

• \.github\ github的相关配置目录，主要存储了action自动化脚本
• \conf\ 程序的配置文件解析，默认配置文件存放目录
• \lib\ 程序的主要代码目录，包含了核心的各项功能，包括答题，看文章，看视频，telegram
• \model\ 程序的用户数据存储，封装了对sqlite的操作
• \push\ 程序的推送配置，主要包括钉钉推送和pushplus推送
• \web\ 程序的web端操作和微信公众的操作
• \utils\ 程序的一些工具类封装

运行时生成的目录

• \config\ 程序的配置文件config.yml的存放目录
• \config\logs\ 程序的日志文件存放目录
• \dist\ 留给用户存放自定义静态文件的目录，映射路径为 \dist，需手动添加并重启程序