Skip to content

Commit 5d48601

Browse files
committed
docs: restructure README and update contributing guidelines
1 parent 48f98aa commit 5d48601

File tree

2 files changed

+25
-4
lines changed

2 files changed

+25
-4
lines changed

Contributing.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ git checkout -b feature-name
3333
```
3434

3535
### 5. Make your changes
36-
Follow the **code structure** of the project. Test your changes locally by opening `index.html` in your browser.
36+
Follow the **project structure** strictly:
37+
38+
- Keep `index.html` at the root.
39+
- Place CSS & JS files inside the `src/` folder.
40+
- Store images, icons, and fonts inside the `assets/` folder.
41+
- Add configuration files (like ESLint, Prettier, etc.) in the `config/` folder if needed.
42+
- Write or update test files inside the `tests/` folder.
43+
44+
After making changes, test them locally by opening `index.html` in your browser.
3745

3846
### 6. Commit your changes
3947
Write a meaningful commit message:

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# CodeCanvas: Discover, Share, and Get Inspired! ✨
22

3-
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.
3+
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.
44

55
## About the Project 🌟
66

77
CodeCanvas aims to be a go-to hub for front-end developers to display their work, discover new techniques, and foster a collaborative environment. We believe in the power of sharing and learning from each other, making front-end development more accessible and exciting for everyone.
88

9-
##SCREENSHOTS
9+
## SCREENSHOTS
1010

1111
<img width="1848" height="873" alt="image" src="https://github.com/user-attachments/assets/70fc2f4c-d973-4821-951d-15247f791402" />
1212
<img width="1892" height="873" alt="image" src="https://github.com/user-attachments/assets/489c2b11-3ad2-4d48-a535-3567df34bdf6" />
@@ -28,6 +28,19 @@ CodeCanvas is built with the foundational technologies of web development, ensur
2828
* **CSS:** For styling the user interface, creating an engaging and responsive design.
2929
* **JavaScript:** For adding interactivity and dynamic functionalities to the platform.
3030

31+
## Project Structure 📂
32+
33+
CodeCanvas/
34+
│── index.html # Entry point of the project
35+
│── src/ # Core CSS and JS files
36+
│ ├── css/ # Stylesheets
37+
│ └── js/ # Scripts
38+
│── assets/ # Images, icons, fonts
39+
│── tests/ # Test files
40+
│── config/ # Configuration files
41+
│── README.md # Documentation
42+
│── CONTRIBUTING.md # Contribution guidelines
43+
3144
## Open Source Ready Features ✅
3245

3346
This project is meticulously designed to be **excellent for open source contributions**. We've focused on simplicity, clarity, and extensibility to ensure a smooth experience for anyone looking to contribute.
@@ -62,7 +75,7 @@ We'd love for you to contribute to CodeCanvas! Here's how you can get started:
6275
5. **Commit** your changes and **push** them to your forked repository.
6376
6. Create a **pull request** to the `main` branch of this repository, describing your contributions.
6477

65-
Please refer to our `CONTRIBUTING.md` (coming soon!) for more detailed guidelines.
78+
Please refer to our [Contributing Guidelines](CONTRIBUTING.md) for more detailed instructions.
6679

6780
## Get in Touch 💬
6881

0 commit comments

Comments
 (0)