Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (43 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

73 lines (43 loc) · 1.62 KB

Contributing to WebDev Projects Repository

🎉 Welcome! This repository collects small web-development projects.
You can contribute by adding a new project inside the projects/ folder.

🛠 How to Add a New Project

1. Fork & Clone

  • Fork this repository to your GitHub account.
  • Clone your fork: 
    git clone https://github.com/<your-username>/<repo-name>.git
cd <repo-name>

2. Create a Branch

Create a branch with a descriptive name:

git checkout -b add/

Example: add/todo-app or add/css-animation-demo.

3. Project Folder Structure

Inside the projects/ directory, create a new folder:

projects/ └── your-project-name/ ├── index.html ├── style.css ├── script.js └── README.md

index.html – main HTML file

style.css – optional CSS

script.js – optional JavaScript

README.md – explain your project (features, screenshots, how to run)

You can add extra assets (images, fonts, etc.) inside your project folder only.

4. Coding Guidelines

Use clean, semantic HTML and organized CSS/JS.

Keep all files self-contained—no changes outside your project folder.

Make sure your project runs by simply opening index.html in a browser.

5. Test Locally

Open projects/your-project-name/index.html in a browser and confirm it works.

6. Commit & Push

git add projects/your-project-name git commit -m "Add mini web project" git push origin add/

7. Open a Pull Request

Go to your fork and click New Pull Request.

Provide:

A short description of your project

Any screenshots or demo links