diff --git a/readme.md b/readme.md index 322cdd7..10ff064 100644 --- a/readme.md +++ b/readme.md @@ -1,51 +1,59 @@ -# 🌞 Open Summer of Code '25 Web Development Assignments +# 🌞 Open Summer of Code 2025 β€” Web Development Track -Welcome to the official repository for the **Open Summer of Code '25 (OSoC'25)** Web Development assignments! This repository serves as a central hub for all student submissions. +Welcome to the official repository for the **Open Summer of Code 2025 (OSoC'25)** Web Development assignments! This repository acts as the central submission point for all participating students in the Web Development track. --- -## πŸš€ Getting Started +## πŸš€ Overview -This repository is where you will submit your completed assignments for the Web Development track of OSoC'25. Please follow the guidelines below carefully to ensure your submissions are processed correctly. +This repository is designated for uploading and organizing your completed assignments throughout the OSoC'25 program. Please ensure that you follow the instructions carefully to maintain consistency and facilitate a smooth review process. --- -## πŸ“ Submission Guidelines +## πŸ“₯ Submission Guidelines -To keep everything organized, please adhere to the following submission structure: +To submit your assignments, please follow the steps below: -1. **Fork this repository:** - Start by forking this repository to your own GitHub account. +1. **Fork this repository** + Create a copy of this repository under your own GitHub account. -2. **Create a dedicated folder for your assignments:** - - Inside the `assignments/` directory, create a new folder named after your GitHub username. - Example: `assignments/your-github-username/` +2. **Create your personal assignment folder** + Inside the `assignments/` directory, create a folder named exactly as your GitHub username. + **Example:** + `assignments/your-github-username/` -3. **Organize by assignment:** - - For each assignment, create a subfolder inside your username directory. - Example: `assignments/your-github-username/assignment-1/` +3. **Organize each assignment properly** + For each assignment, create a separate subfolder inside your personal directory. + **Example:** + `assignments/your-github-username/assignment-1/` -4. **Name your files clearly:** - - Use descriptive and conventional names like `index.html`, `styles.css`, and `script.js`. +4. **Name your files descriptively** + Use conventional and meaningful names like: + - `index.html` + - `style.css` + - `app.js` -5. **Include a README.md in each assignment folder:** - This file should include: - - Assignment name - - A short description of what the assignment does - - (Optional) Challenges faced and how you overcame them +5. **Include a `README.md` in each assignment folder** + This file should contain: + - Assignment title + - A brief summary of what the assignment does + - *(Optional)* Challenges you faced and how you solved them -6. **Commit your changes:** - - Write clear and concise commit messages for each change. +6. **Write clear commit messages** + Make sure each commit message clearly describes the changes you’ve made. -7. **Create a Pull Request (PR):** - - After completing an assignment, push your changes to your forked repository. - - Open a Pull Request to this original repository. - - **PR Title Format:** `Assignment 1: [Your Name] - Basic HTML Page` - - **PR Description:** Brief summary of your work. +7. **Submit a Pull Request (PR)** + After completing your assignment: + - Push your changes to your forked repository + - Open a Pull Request to this repository + - **PR Title Format:** + `Assignment 1: [Your Full Name] - Basic HTML Page` + - **PR Description:** + Include a brief summary of your implementation --- -## πŸ“‚ Project Structure +## πŸ“ Directory Structure ```text . @@ -53,22 +61,24 @@ To keep everything organized, please adhere to the following submission structur β”‚ └── your-github-username/ β”‚ β”œβ”€β”€ assignment-1/ β”‚ β”‚ β”œβ”€β”€ index.html -β”‚ β”‚ β”œβ”€β”€ styles.css -β”‚ β”‚ β”œβ”€β”€ script.js +β”‚ β”‚ β”œβ”€β”€ style.css +β”‚ β”‚ β”œβ”€β”€ app.js β”‚ β”‚ └── README.md β”‚ └── assignment-2/ β”‚ β”œβ”€β”€ index.html β”‚ └── README.md -└── README.md (this file) - - +└── README.md ← This file +``` --- +## πŸ“ž Support +If you encounter any issues or have questions, feel free to contact your assigned mentors or reach out via the official OSoC'25 WhatsApp group. -## πŸ“ž Contact +--- +## πŸ’‘ Final Notes +Stay consistent, write clean code, and don’t forget to document your learnings! +We look forward to seeing your creativity and growth throughout this journey. -If you have any questions or need assistance, please reach out to your mentors or the OSoC'25 organizers through the WhatsApp Group +Happy coding! ✨ +β€” The OSoC'25 Web Development Mentorship Team --- - -Happy coding and best of luck! πŸš€ -– The OSoC'25 Web Dev Mentorship Team