diff --git a/plugins/README.md b/plugins/README.md new file mode 100644 index 0000000..2d9a611 --- /dev/null +++ b/plugins/README.md @@ -0,0 +1,20 @@ +# 贡献分享 +南墙 的发展离不开社区的每一位贡献者,希望大家踊跃为 南墙 贡献功能插件和安全规则。规则模板见:https://github.com/Safe3/uuWAF/blob/main/rules/anti-cc.lua ,规则API见:https://waf.uusec.com/#/api/README 。 + + +## :gift_heart: 参与方法 +> 贡献者以 PR 的方式向 github 南墙社区仓库内提交。 +- 规则提交位置: https://github.com/Safe3/uuWAF/tree/master/rules +- 插件提交位置: https://github.com/Safe3/uuWAF/tree/master/plugins +- PR 中根据 Pull Request 的模板填写规则或插件信息 +- 内部审核 PR,确定是否合并入仓库 +- 每次发布新版时,CI 拉取 Github 仓库,并将社区的规则和插件打包进社区版共享给大家 + + + +## :gem: 奖励措施 +> 参与贡献即可获得与 uuWAF 社区版内部大佬技术切磋交流的机会。提交 PR 过程中会有内部大佬审核,帮助改进规则和插件,共同进步。 + +- 提交一个规则或插件即可进入 uuWAF 核心贡献者群,参与讨论热点安全技术,且有机会与大佬们面对面交流。 +- 对于 uuWAF 商业版年费用户,在当年的商业版授权有效期内,只需在提交5个插件或规则,即可再免费续一年商业升级。 +- 参与贡献的人员可永久将你的大名留在规则贡献者名单当中,供所有人瞻仰。