|
@@ -1,4 +1,3 @@
|
|
-
|
|
|
|
# Contributing to AdminLTE
|
|
# 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)
|
|
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
|
|
```bash
|
|
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
|
|
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
|
|
```
|
|
```
|
|
- * Create a new branch
|
|
|
|
|
|
+ * Create a new branch from `master`
|
|
3. Compile dist files (Development) :
|
|
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 install` (install npm deps)
|
|
* `npm run dev` (developer mode, autocompile with browsersync support for live demo)
|
|
* `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
|
|
## 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.
|
|
- clone the `AdminLTE` repo.
|
|
|
|
+- Open with [Codespace](https://docs.github.com/en/codespaces) or [](https://gitpod.io/from-referrer/)
|
|
- install the dependencies.
|
|
- install the dependencies.
|
|
- run `npm run dev` to start the server.
|
|
- run `npm run dev` to start the server.
|
|
-
|
|
|
|
-[](https://gitpod.io/from-referrer/)
|
|
|