mirror of https://github.com/ColorlibHQ/AdminLTE
minor changes for v4
Daniel
REJack
parent
23bdd7642d
commit
4553a244cc
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
# Contributing to AdminLTE
|
||||
|
||||
Contributions are always **welcome and recommended**! Here is how for beginner's: [Get started with open source click here](https://youtu.be/GbqSvJs-6W4)
|
||||
|
|
@ -15,23 +14,21 @@ Contributions are always **welcome and recommended**! Here is how for beginner's
|
|||
```bash
|
||||
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
|
||||
```
|
||||
* Create a new branch
|
||||
* Create a new branch from `master`
|
||||
3. Compile dist files (Development) :
|
||||
* To compile the dist files you need Node.js 10 or higher/npm (node package manager)
|
||||
* Delete ./package-lock.json file
|
||||
* To compile the dist files you need Node.js 18 or higher/npm (node package manager)
|
||||
* `npm install` (install npm deps)
|
||||
* `npm run dev` (developer mode, autocompile with browsersync support for live demo)
|
||||
* Make your changes only in ./buid Folder OR package.json OR ./dist/js/demo.js OR in any html files which nessary to contribute
|
||||
* Do not changes in ./dist/css/ AND ./dist/js/ Because its compiled files
|
||||
* `npm run production` (compile css/js files and test every pages are perfectly working fine, before creating pull request)
|
||||
4. Create a pull request
|
||||
* Make your changes only in `./src` Folder OR `package.json` in any files which are necessary for contribution
|
||||
* Do not make changes in `./dist/**` Because it contains compiled files and do not include in PR (Pull Request)
|
||||
* `npm run production` (compile css/js files and test all pages are perfectly working fine, before creating a pull request)
|
||||
4. Create a pull request to `master` branch
|
||||
|
||||
## Online one-click setup for contributing
|
||||
|
||||
You can use Gitpod(an online IDE which is free for Open Source) for working on issues or making Prs. With a single click it will launch a workspace and automatically:
|
||||
You can use [Codespace](https://docs.github.com/en/codespaces) an online IDE which is free for Open Source for working on issues or making PRs (Pull Requests). With a single click it will launch a workspace and automatically:
|
||||
|
||||
- clone the `AdminLTE` repo.
|
||||
- Open with [Codespace](https://docs.github.com/en/codespaces) or [](https://gitpod.io/from-referrer/)
|
||||
- install the dependencies.
|
||||
- run `npm run dev` to start the server.
|
||||
|
||||
[](https://gitpod.io/from-referrer/)
|
||||
|
|
|
|||
|
|
@ -40,4 +40,4 @@ jobs:
|
|||
run: npm run bundlewatch
|
||||
env:
|
||||
BUNDLEWATCH_GITHUB_TOKEN: "${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}"
|
||||
CI_BRANCH_BASE: v4-dev
|
||||
CI_BRANCH_BASE: master
|
||||
|
|
@ -3,12 +3,12 @@ name: "CodeQL"
|
|||
on:
|
||||
push:
|
||||
branches:
|
||||
- v4-dev
|
||||
- master
|
||||
- "!dependabot/**"
|
||||
pull_request:
|
||||
# The branches below must be a subset of the branches above
|
||||
branches:
|
||||
- v4-dev
|
||||
- master
|
||||
- "!dependabot/**"
|
||||
schedule:
|
||||
- cron: "0 0 * * 0"
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
tasks:
|
||||
- init: npm install
|
||||
command: npx gulp
|
||||
command: npm run dev
|
||||
ports:
|
||||
- port: 3000
|
||||
onOpen: open-preview
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
[](https://www.npmjs.com/package/admin-lte)
|
||||
[](https://packagist.org/packages/almasaeed2010/adminlte)
|
||||
[](https://www.jsdelivr.com/package/npm/admin-lte)
|
||||
[](https://gitpod.io/from-referrer/)
|
||||
[](https://discord.gg/jfdvjwFqfz)
|
||||
[](https://app.netlify.com/sites/adminlte-v4/deploys)
|
||||
|
||||
|
|
@ -38,11 +37,11 @@ To compile the dist files you need Node.js/npm, clone/download the repo then:
|
|||
- First thing first, you should have bit knowledge about NodeJS.
|
||||
- Github Knowledge.
|
||||
- Install NodeJS LTS version.
|
||||
- Clone this Repository to your machine and change to `v4-dev` branch.
|
||||
- Clone this Repository to your machine and change to `master` branch.
|
||||
- Go to Cloned Folder.
|
||||
- In cli/bash run `npm install` it will install dependency from `package.json`.
|
||||
- After installation complets, run `npm run dev`
|
||||
- Cool, Send urs changes in PR to `v4-dev` branch.
|
||||
- Cool, Send urs changes in PR to `master` branch.
|
||||
|
||||
|
||||
## License
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Contributions are always **welcome and recommended**! Here is how for beginner's
|
|||
```bash
|
||||
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
|
||||
```
|
||||
* Create a new branch from `v4-dev`
|
||||
* Create a new branch from `master`
|
||||
3. Compile dist files (Development) :
|
||||
* To compile the dist files you need Node.js 18 or higher/npm (node package manager)
|
||||
* `npm install` (install npm deps)
|
||||
|
|
@ -22,13 +22,13 @@ Contributions are always **welcome and recommended**! Here is how for beginner's
|
|||
* Make your changes only in `./src` Folder OR `package.json` in any files which are necessary for contribution
|
||||
* Do not make changes in `./dist/**` Because it contains compiled files and do not include in PR (Pull Request)
|
||||
* `npm run production` (compile css/js files and test all pages are perfectly working fine, before creating a pull request)
|
||||
4. Create a pull request to `v4-dev` branch
|
||||
4. Create a pull request to `master` branch
|
||||
|
||||
## Online one-click setup for contributing
|
||||
|
||||
You can use [Codespace](https://docs.github.com/en/codespaces) an online IDE which is free for Open Source for working on issues or making PRs (Pull Requests). With a single click it will launch a workspace and automatically:
|
||||
|
||||
- clone the `AdminLTE` repo.
|
||||
- Open with [Codespace](https://docs.github.com/en/codespaces)
|
||||
- Open with [Codespace](https://docs.github.com/en/codespaces) or [](https://gitpod.io/from-referrer/)
|
||||
- install the dependencies.
|
||||
- run `npm run dev` to start the server.
|
||||
|
|
|
|||
Loading…
Reference in New Issue