Skip to content

Commit a24a864

Browse files
committed
docs: restructure README and update contributing guidelines
1 parent bd8af46 commit a24a864

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
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: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
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
[![Open Source](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/Varshitha713/CodeCanvas)
66

@@ -105,6 +105,18 @@ CodeCanvas is built with the foundational technologies of web development, ensur
105105
<div align="center">
106106
<img src="https://user-images.githubusercontent.com/74038190/212284115-f47cd8ff-2ffb-4b04-b5bf-4d1c14c0247f.gif" width="1000">
107107
</div>
108+
## Project Structure 📂
109+
110+
CodeCanvas/
111+
│── index.html # Entry point of the project
112+
│── src/ # Core CSS and JS files
113+
│ ├── css/ # Stylesheets
114+
│ └── js/ # Scripts
115+
│── assets/ # Images, icons, fonts
116+
│── tests/ # Test files
117+
│── config/ # Configuration files
118+
│── README.md # Documentation
119+
│── CONTRIBUTING.md # Contribution guidelines
108120

109121
## Open Source Ready Features ✅
110122

@@ -155,6 +167,7 @@ We'd love for you to contribute to CodeCanvas! Here's how you can get started:
155167
<div align="center">
156168
<img src="https://user-images.githubusercontent.com/74038190/212284115-f47cd8ff-2ffb-4b04-b5bf-4d1c14c0247f.gif" width="1000">
157169
</div>
170+
Please refer to our [Contributing Guidelines](CONTRIBUTING.md) for more detailed instructions.
158171

159172
### 🙌 **Thank You, Contributors!**
160173

0 commit comments

Comments
 (0)