diff --git a/Contributing.md b/Contributing.md index 3e73d97..eea6b65 100644 --- a/Contributing.md +++ b/Contributing.md @@ -33,7 +33,15 @@ git checkout -b feature-name ``` ### 5. Make your changes -Follow the **code structure** of the project. Test your changes locally by opening `index.html` in your browser. +Follow the **project structure** strictly: + +- Keep `index.html` at the root. +- Place CSS & JS files inside the `src/` folder. +- Store images, icons, and fonts inside the `assets/` folder. +- Add configuration files (like ESLint, Prettier, etc.) in the `config/` folder if needed. +- Write or update test files inside the `tests/` folder. + +After making changes, test them locally by opening `index.html` in your browser. ### 6. Commit your changes Write a meaningful commit message: diff --git a/README.md b/README.md index c026835..bf012f6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # CodeCanvas: Discover, Share, and Get Inspired! ✨ -Welcome to **CodeCanvas**, a vibrant community platform where developers from around the globe can showcase their amazing front-end projects, get inspired, and connect with fellow creators. Whether you're a seasoned pro or just starting your journey, this is the perfect place to share your creativity and explore innovative designs. +Welcome to CodeCanvas, a vibrant community platform where developers from around the globe can showcase their amazing front-end projects, get inspired, and connect with fellow creators. Whether you're a seasoned pro or just starting your journey, this is the perfect place to share your creativity and explore innovative designs. [![Open Source](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/Varshitha713/CodeCanvas) @@ -105,6 +105,18 @@ CodeCanvas is built with the foundational technologies of web development, ensur
+## Project Structure 📂 + +CodeCanvas/ +│── index.html # Entry point of the project +│── src/ # Core CSS and JS files +│ ├── css/ # Stylesheets +│ └── js/ # Scripts +│── assets/ # Images, icons, fonts +│── tests/ # Test files +│── config/ # Configuration files +│── README.md # Documentation +│── CONTRIBUTING.md # Contribution guidelines ## Open Source Ready Features ✅ @@ -155,6 +167,7 @@ We'd love for you to contribute to CodeCanvas! Here's how you can get started:
+Please refer to our [Contributing Guidelines](CONTRIBUTING.md) for more detailed instructions. ### 🙌 **Thank You, Contributors!** diff --git a/index.html b/index.html index 8c5ff97..22a3b90 100644 --- a/index.html +++ b/index.html @@ -16,7 +16,13 @@ + chore/restructure-readme + + + + + master @@ -283,6 +289,14 @@

+
+ +

Message Delivered

+
+ + +
diff --git a/script.js b/src/script.js similarity index 100% rename from script.js rename to src/script.js diff --git a/style.css b/src/style.css similarity index 100% rename from style.css rename to src/style.css