如何贡献
参与 AdminLTE 贡献
我们始终欢迎并推荐大家贡献代码!初学者请参考这里:点击此处开始开源之旅
-
贡献要求:
- 当您贡献代码时,即表示您同意授予 AdminLTE.io 非独占许可,允许我们(AdminLTE.io)在任何我们认为合适的场景中使用该贡献。
- 如果您使用了第三方提供的内容,则必须通过开源许可证进行适当授权。
- 贡献仅通过 GitHub Pull Request 方式接受。
- 最后,贡献的代码必须在所有支持的浏览器中正常工作(浏览器支持请参见上文)。
-
安装步骤:
- Fork 该仓库(指南参见此处)。
- 克隆到本地
git clone https://github.com/YOUR_USERNAME/AdminLTE.git- 从
master分支创建一个新分支
-
编译 dist 文件(开发环境):
- 编译 dist 文件需要 Node.js 18 或更高版本以及 npm(Node 包管理器)
npm install(安装 npm 依赖)-
npm run dev(开发者模式,自动编译并支持 Browsersync 实时演示) -
请仅在
./src文件夹或package.json中对贡献所需的文件进行修改 -
请勿在
./dist/**中进行修改,因为该目录包含编译后的文件,且不应包含在 PR(Pull Request)中 -
npm run production(编译 CSS/JS 文件,并在创建 Pull Request 之前测试所有页面是否完全正常工作)
-
向
master分支发起 Pull Request
一键在线贡献环境搭建
您可以使用 Codespace(一个在线 IDE,对开源项目免费)来处理 Issue 或发起 PR(Pull Request)。只需单击一次,它就会启动一个工作空间,并自动:
- 克隆
AdminLTE仓库。 -
通过 Codespace 打开,或
- 安装依赖。
- 运行
npm run dev启动服务器。