doc: improve doc for contribution

Signed-off-by: Jérôme Engeln <[email protected]> doc: improve doc for contribution Signed-off-by: Jérôme Engeln <[email protected]>
agence-adeliom · Mar 7, 2024 · 49ce2f1 · 49ce2f1
1 parent 81ac5b7
commit 49ce2f1
Show file tree

Hide file tree

Showing 7 changed files with 60 additions and 48 deletions.
diff --git a/Makefile b/Makefile
@@ -113,21 +113,24 @@ help: ## Dislay this help
 	done; unset IFS;
 .PHONY: help
 
-apply-changes:
-	cp -r assets ${TEST_DIRECTORY}/themes/TailwindTheme
-	cp -r templates ${TEST_DIRECTORY}/themes/TailwindTheme
-
-build-changes:
-	${NPM} install
-	${NPM} run build
-
-watch-changes:
+get-changes:
+	rm -rf ./assets
+	rm -rf ./templates
+	rm -rf ./tailwind.config.js
+	rm -rf ./postcss.config.js
+	cp -r ${TEST_DIRECTORY}/themes/TailwindTheme/assets ./
+	cp -r ${TEST_DIRECTORY}/themes/TailwindTheme/templates ./
+	cp ${TEST_DIRECTORY}/tailwind.config.js ./tailwind.config.js
+	cp ${TEST_DIRECTORY}/postcss.config.js ./postcss.config.js
+
+
+watch:
 	${NPM} install
 	${NPM} run watch
 
-lint-changes:
-	$(DDEV) composer install
-	$(DDEV) exec vendor/bin/twigcs templates/ --severity error --display blocking --reporter githubAction
+lint:
+	composer install
+	vendor/bin/twigcs templates/ --severity error --display blocking --reporter githubAction
 
 ###
 ### CI TEST

diff --git a/README.md b/README.md
@@ -1,22 +1,4 @@
-<p align="center">
-    <a href="https://sylius.com" target="_blank">
-        <svg xmlns="http://www.w3.org/2000/svg" class="max-h-10 w-full" version="1.2" viewBox="0 0 601 177" width="601" height="177">
-          <style>
-               .st0{fill:#1e2e3e;}
-                @media (prefers-color-scheme: dark) {
-                .st0{fill:#FFF;}
-              }
-               .st1{fill:#30BA9D;}
-               .st2{fill:#1A9F83;}
-          </style>
-          <path class="st0" d="m220.1 121.2c0 0 10.5 12.3 25.7 12.3 9.6 0 17.6-5.8 17.6-15.2 0-21.5-49.5-18.1-49.5-50.1 0-15.4 13.5-27.4 32.8-27.4 10.9 0 29.2 4.9 29.2 18.9v8.4h-13.4v-4.8c0-5.4-7.7-9.3-15.8-9.3-11 0-18 6.1-18 13.8 0 20.8 49.4 16.1 49.4 49.8 0 15.7-12.2 29.2-32.5 29.2-13 0-25.3-5.6-34-15.2zm81.1 42.1c5.7 0 10.2-4.1 12.9-10.6l3.3-8-25.1-58.2c-1-2.3-2.3-2.9-4.6-2.9h-1.7v-12.1h8.3c5.9 0 8.1 1.6 10.5 7.4l16.7 41.4c1.1 2.9 1.9 5.8 2.6 8.8h0.3c0.6-3 1.4-6 2.5-8.8l15.1-41.3c2.2-5.8 4.8-7.4 10.7-7.4h8.4v12.1h-1.9c-2.3 0-3.6 0.6-4.7 2.9l-29 71.7c-4.5 11.3-13.3 17.3-23.7 17.3-6.5 0-12.7-2.6-17.3-7.3l5.8-10.2c0.2 0.1 4.7 5.2 10.9 5.2zm74-105.5c0-2.2-1.2-3.2-3.2-3.2h-5.9v-12.1h13.9c6.5 0 9.3 2.8 9.3 9.3v77.9c0 2.2 1.1 3.2 3.2 3.2h5.9v12h-13.9c-6.5 0-9.3-2.8-9.3-9.3zm44 29c0-2.2-1.2-3.2-3.2-3.2h-6v-12.1h13.8c6.5 0 9.3 2.8 9.3 9.3v48.9c0 2.2 1.1 3.2 3.2 3.2h5.9v12h-13.8c-6.5 0-9.3-2.8-9.3-9.3zm0.3-44.2h12.6v14.7h-12.6zm40.6 44.2c0-2.2-1.2-3.2-3.2-3.2h-6v-12.1h13.8c6.7 0 9.4 2.8 9.4 9v34.8c0 10.2 2 18.3 13.6 18.3 15.1 0 23.9-13.2 23.9-27.7v-34.4h14.1v58.2c0 2.2 1.2 3.2 3.2 3.2h6v12h-13.5c-6.2 0-9.3-2.9-9.3-8.1v-2.7c0-2.3 0.1-4.2 0.1-4.2h-0.2c-3 7.3-12.4 16.9-27 16.9-16.6 0-25-8.7-25-28.2v-31.8zm91.2 37.6c0 0 8.7 10.9 22.2 10.9 6.8 0 12.8-3 12.8-9.4 0-13.2-40.1-11.8-40.1-35.4 0-14.1 12.3-20.7 27.3-20.7 8.9 0 24.1 3 24.1 14.2v7h-12.6v-3.6c0-4.4-6.5-6.3-11-6.3-8.3 0-13.6 2.9-13.6 8.7 0 13.9 40.1 10.9 40.1 35.4 0 13-11.6 21.5-27 21.5-19.6 0-29.3-12.9-29.3-12.9z"></path>
-          <path class="st1" d="m24.9 103.5l35.3 70.6 65.2 0.1 15.7-22.2z"></path>
-          <path class="st2" d="m0.4 111.3l47.5 65.1 77.5 0.1 15.7-24.4zm56.9-79.4l23.1 17.9 20.9-40.1-7.1-4.5z"></path>
-          <path class="st1" d="m125.4 176.6l-68.1-144.7 14.5-10.5 79.2 115.4zm-24.5-176.4l31.1 45.6-44.3-35.8z"></path>
-     </svg>
-    </a>
-</p>
-
+![Sylius logo!](./docs/medias/sylius.svg)
 <h1 align="center">SyliusTailwindcssTheme by Adeliom</h1>
 
 <h6 align="center">Sylius theme powered by Tailwindcss, DaisyUI, SyliusThemeBundle, WebpackEncoreBundle.</h6>
@@ -31,7 +13,7 @@ TODO
 |:-----------------|---------------------------------------------------------------------------------:|
 | Demo             |                                [Visit our demo site](https://www.adeliom.com) 🚀 |
 | Screenshots      | ![notes!](./docs/medias/home1.png)<br/>[View more](./docs/screenshots.md) |
-| Performances     |                                               ![notes!](./docs/medias/notes.png) |
+| Performances     |                                           ![notes!](./docs/medias/notes.png)    |
 
 
 ## Documentation

diff --git a/docs/contribution.md b/docs/contribution.md
@@ -1,4 +1,4 @@
-## Quickstart Installation
+## Installation for contribution & test
 
 ### Prerequis
 
@@ -11,7 +11,8 @@
 2. Run install command : 
 
     ```bash
-    $ make install-project
+    $ make install-project # first install or after a remove
+    $ make start # project already installed
     ```
     Default values : XX=1.12.13 and YY=6.4 and ZZ=8.2
 
@@ -30,26 +31,37 @@
 
 ### Modify code
 
-After project installation, you can modify themes files here `templates/bundles/`.
-To send files into your installed test project just execute following command after changes :
+1. After project installation, you can modify themes files here `install/Application/themes/TailwindTheme` assets and templates files. 
 
-1. Apply changes
+2. To compile tailwind and assets changes use :
 
     ```bash
-    $ make apply-changes
+    $ make watch
     ```
 
-2. Build changes
+3. When changes are done you have to put back your modification into this root project.
 
     ```bash
-    $ make build-changes
-    # Or
-    $ make watch-changes
+    $ make get-changes
     ```
 
-3. Lint changes
+    You can do it manually or you can execute `make get-changes`
+
+    This command will get back `templates` and `assets` folder, `tailwind.config.js`, `postcss.config.js` file into root folder.
+
+
+4. Lint before commit
 
     ```bash
-    $ make lint-changes
+    $ make lint
     ```
 
+    This command will use your own composer and php version
+
+
+5. git commit & push
+
+### Contribution
+
+1. Fork this github project
+2. Create an issue and pull request
diff --git a/docs/index.md b/docs/index.md
@@ -2,9 +2,10 @@
 
 ### Summary
 
-| 📚                  |                                            |
-|:--------------------|-----------------------------------------------:|
-| **1. Installation** |                   [Read here](installation.md) |
+| 📚                                         |                              |
+|:-------------------------------------------|-----------------------------:|
+| **1. Installation in your Sylius project** | [Read here](installation.md) |
+| **1. Installation for contribution**       | [Read here](contribution.md) |
 
 ### Learn more
 

diff --git a/docs/installation_as_package.md b/docs/installation_as_package.md
@@ -3,7 +3,7 @@
 It means all files are installed as a composer dependency (into vendor directory).
 Then you override templates of your needs by copying files into : `./themes/TailwindTheme/templates/bundles/SyliusShopBundle/...`
 
-Installation as a composer dependency [is documented here for bootstrapTheme](./docs/COMPOSER_INSTALLATION.md).
+Installation as a composer dependency [is documented here for Sylius bootstrapTheme](https://docs.sylius.com/en/1.12/book/themes/bootstrap-theme.html#creating-a-new-theme-based-on-bootstraptheme).
 You can follow the same steps, just replace `bootstrap` by `tailwind`
 
 ```bash

diff --git a/docs/medias/notes.png b/docs/medias/notes.png
diff --git a/docs/medias/sylius.svg b/docs/medias/sylius.svg