|
2 | 2 |
|
3 | 3 | ## About the Project |
4 | 4 |
|
5 | | -We are developing the theme from scratch for gathering experiences. This is not for distribution or for any commercial use. By building this theme we can learn more deep knowledge about shopify theme development. Also, we will learn about big project management and planning for big projects. Developer who will contribute by making plans, fixing bugs, and adding new features, they can use the theme as their portfolio as their contribution, the overall goal of the project is learning and work footprint. |
6 | | - |
7 | | -Join in this journey of exploration, growth, and community collaboration in Shopify theme development! |
| 5 | +I am developing this theme from scratch for gathering experiences. This is not for distribution or for any commercial use. By building this theme I can learn more deep knowledge about shopify theme development. Also, I will learn about big project management and planning for big projects. Developer who will contribute by making plans, fixing bugs, and adding new features, they can use the theme as their portfolio as they contributed, the overall goal of the project is learning and making work footprint. |
8 | 6 |
|
9 | 7 | ## 2. Contribution Guide |
10 | 8 |
|
11 | | -Hello developers, welcome to this project. By contributing to this project enhance your development knowledge and build a portfolio to showcase your skill. You can fix bugs, implement new features, or improve documentation, your contribution is highly valuable. |
| 9 | +Hello developers, welcome to this project. By contributing to this project, enhance your development knowledge and build a portfolio to showcase your skill. Your contribution can be fixing bug, implementing new features, or improve the documentation, your contribution is highly valuable. |
12 | 10 |
|
13 | 11 | ### How to Contribute: |
14 | 12 |
|
15 | 13 | 1. Fork the repository. |
16 | 14 | 2. Create a new branch for your contribution. |
17 | 15 | 3. Get the theme code in your local machine and connect it to your development store. |
18 | | -4. To connect upload the code in your development store. |
19 | | -5. Use `Shopify Theme Kit` for development. |
20 | | -6. Make your changes and ensure they adhere to the coding standards. |
21 | | -7. Submit a pull request with a clear description of your changes. |
| 16 | +4. Make your changes and ensure they adhere to the coding standards. |
| 17 | +5. Submit a pull request with a clear description of your changes. |
22 | 18 |
|
23 | 19 | ### Technology: |
24 | 20 |
|
25 | 21 | 1. `Bootsrup` for UI styleing and functionality |
26 | | -2. `Fonts` self hosted. Can be found in `snippets` folder as svg |
27 | | -3. total zip file size should be less than 1 mb. |
28 | 22 |
|
29 | 23 | ### Code Style: |
30 | 24 |
|
31 | | -- We adhere to the Dawn theme code style in our development process. |
32 | | -- Each section file is named starting with `main-`. |
33 | | -- Initially, we did not utilize localized translation for simplicity. |
34 | | -- Our code prioritizes simplicity and ensuring optimization. |
35 | | -- We maximize the use of reusable code by incorporating snippets wherever possible. |
36 | | -- A global `js` file is maintained for consolidated JavaScript functionality. |
37 | | -- Similarly, a global `css` file is employed for unified styling. |
38 | | -- For additional functionalities, we consider dedicated `css` and `js` files. |
| 25 | +- I adhere to the Dawn theme code style in our development process. |
| 26 | +- Each page section file is named starting with `main-`. |
| 27 | +- Initially, I did not utilize localized translation for simplicity. |
| 28 | +- My code prioritizes simplicity and ensuring optimization. |
| 29 | +- I maximize the use of reusable code by incorporating snippets wherever possible. |
| 30 | +- For simplicity, I use bootstrap `js` and `css` files. this can be found in `assets` folder. |
| 31 | +- `script.js` file is maintained for consolidated JavaScript functionality. |
| 32 | +- for product variant selection functionality, I use `variants.js` file. |
| 33 | +- `style.css` file is employed for unified styling. |
| 34 | +- For additional functionalities, I consider dedicated `css` and `js` files. |
39 | 35 | - Images and videos are optimized using the default liquid optimization for enhanced performance. |
40 | 36 |
|
41 | 37 | ### Reporting Issues: |
42 | 38 |
|
43 | | -If you encounter any issues or bugs, please [open an issue](https://github.com/yourusername/your-repo/issues) on GitHub. Provide detailed information about the problem, including steps to reproduce it. |
| 39 | +If you encounter any issues or bugs, please [open an issue](https://github.com/osama2kabdullah/Quantaslide/issues) on GitHub. Provide detailed information about the issue, including steps to reproduce it (if possible). |
44 | 40 |
|
45 | 41 | ## 3. Installation Guide |
46 | 42 |
|
47 | 43 | 1. Download all code by CLI or github download system. |
48 | 44 | 2. Upload this in your development store and make sure it is a `zip` file. |
49 | | -3. Installtion complete. |
| 45 | +3. Done. |
50 | 46 |
|
51 | 47 | ## 4. Distribution Policy |
52 | 48 |
|
|
0 commit comments