From b0edd9ff8f11554c99986121daa44e6f768c57f1 Mon Sep 17 00:00:00 2001 From: Ayush Sharma Date: Tue, 4 Nov 2025 22:50:30 +0530 Subject: [PATCH 1/7] Adding code of Conduct, contributing, Repositoruy structure markdown files at root, modified & created --- CODE_OF_CONDUCT.md | 140 +++++++++++++++ CONTRIBUTING.md | 385 ++++++++++++++++++++++++++++++++++++++++ REPOSITORY_STRUCTURE.md | 183 +++++++++++++++++++ 3 files changed, 708 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 REPOSITORY_STRUCTURE.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9da1f5f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,140 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +### Examples of behavior that contributes to a positive environment: + +* ✅ Demonstrating empathy and kindness toward other people +* ✅ Being respectful of differing opinions, viewpoints, and experiences +* ✅ Giving and gracefully accepting constructive feedback +* ✅ Accepting responsibility and apologizing to those affected by our mistakes +* ✅ Focusing on what is best for the overall community +* ✅ Using welcoming and inclusive language +* ✅ Being patient with new contributors + +### Examples of unacceptable behavior: + +* ❌ The use of sexualized language or imagery, and sexual attention or advances of any kind +* ❌ Trolling, insulting or derogatory comments, and personal or political attacks +* ❌ Public or private harassment +* ❌ Publishing others' private information without explicit permission +* ❌ Spam or irrelevant contributions +* ❌ Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement: + +- **Harshit Pachori** - [@HarshitPachori](https://github.com/HarshitPachori) +- **Ayush Sharma** - [@ayushHardeniya](https://github.com/ayushHardeniya) + +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations + +--- + +## 🤝 Our Commitment + +We are committed to providing a welcoming and inspiring community for all. We expect all community members to abide by this Code of Conduct in all community venues—online and in-person—as well as in all one-on-one communications. + +**Let's build something amazing together! 🚀** \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ba8d8be --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,385 @@ +# 🤝 Contributing to Hacktoberfest HTML/CSS/JS + +First off, thank you for considering contributing to this project! It's people like you that make open source such a great community. 🎉 + +## 📋 Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [Getting Started](#getting-started) +- [How Can I Contribute?](#how-can-i-contribute) +- [Development Workflow](#development-workflow) +- [Style Guidelines](#style-guidelines) +- [Commit Message Guidelines](#commit-message-guidelines) +- [Pull Request Process](#pull-request-process) +- [Community](#community) + +## 📜 Code of Conduct + +This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the maintainers. + +## 🚀 Getting Started + +### Prerequisites + +- Git installed on your local machine +- GitHub account +- Basic knowledge of HTML, CSS, JavaScript (depending on contribution area) +- Text editor or IDE (VS Code recommended) + +### First Time Contributors + +New to open source? Check these resources: +- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) +- [First Contributions](https://github.com/firstcontributions/first-contributions) +- [GitHub Flow Guide](https://guides.github.com/introduction/flow/) + +## 💡 How Can I Contribute? + +### 🐛 Reporting Bugs + +Before creating bug reports, please check existing issues. When creating a bug report, include: + +- **Clear title and description** +- **Steps to reproduce** +- **Expected behavior** +- **Actual behavior** +- **Screenshots** (if applicable) +- **Environment details** (browser, OS, etc.) + +**Use the bug report template when creating an issue.** + +### ✨ Suggesting Enhancements + +Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion: + +- **Use a clear and descriptive title** +- **Provide detailed description** of the proposed feature +- **Explain why this enhancement would be useful** +- **Include mockups or examples** if applicable + +### 📝 Contributing Code + +#### Areas You Can Contribute To: + +1. **HTML Components** (`html/`) + - Responsive layouts + - Accessible components + - Modern HTML5 features + +2. **CSS Styling** (`css/`) + - Animations and transitions + - Responsive designs + - Theme implementations + +3. **JavaScript Features** (`js/`) + - Interactive components + - Utility functions + - API integrations + +4. **DSA Implementations** + - `dsa_in_js/` - JavaScript + - `dsa_in_cpp/` - C++ + - `dsa_in_java/` - Java + +5. **Design Patterns** (`design_patterns/`) + - Pattern implementations + - Real-world examples + +6. **Tools & Utilities** (`tools/`) + - Development tools + - Helper scripts + +7. **Documentation** + - README improvements + - Code comments + - Tutorials and guides + +## 🔄 Development Workflow + +### Step 1: Get Assigned + +**⚠️ IMPORTANT: Before starting work, create an issue and get assigned by a maintainer.** + +```bash +# Create an issue describing what you want to work on +# Wait for maintainer approval and assignment +``` + +### Step 2: Fork and Clone + +```bash +# Fork the repository on GitHub +# Clone your fork locally +git clone https://github.com/YOUR-USERNAME/Hacktoberfest-Html_CSS_JS.git +cd Hacktoberfest-Html_CSS_JS +``` + +### Step 3: Create a Branch + +```bash +# Create a new branch for your feature +git checkout -b feature/your-feature-name + +# Branch naming conventions: +# feature/add-carousel-component +# fix/navigation-bug +# docs/update-readme +# refactor/optimize-css +``` + +### Step 4: Make Changes + +- Write clean, readable code +- Follow the project's coding standards +- Add comments where necessary +- Test your changes thoroughly + +### Step 5: Commit Changes + +```bash +# Stage your changes +git add . + +# Commit with a meaningful message +git commit -m "feat: add responsive carousel component" +``` + +### Step 6: Push and Create PR + +```bash +# Push to your fork +git push origin feature/your-feature-name + +# Go to GitHub and create a Pull Request +``` + +## 🎨 Style Guidelines + +### HTML Style Guide + +```html + +
+ +
+ + + +Description + + + +``` + +### CSS Style Guide + +```css +/* Use meaningful class names */ +.navigation-menu { + display: flex; + justify-content: space-between; +} + +/* Group related properties */ +.card { + /* Positioning */ + position: relative; + + /* Display & Box Model */ + display: flex; + padding: 1rem; + margin: 1rem 0; + + /* Typography */ + font-size: 1rem; + + /* Visual */ + background-color: #fff; + border-radius: 8px; +} + +/* Use CSS variables for consistency */ +:root { + --primary-color: #007bff; + --spacing-unit: 8px; +} +``` + +### JavaScript Style Guide + +```javascript +// Use camelCase for variables and functions +const userName = 'John'; + +// Use PascalCase for classes +class UserProfile { + constructor(name) { + this.name = name; + } +} + +// Use const for constants +const MAX_USERS = 100; + +// Add JSDoc comments for functions +/** + * Calculates the sum of two numbers + * @param {number} a - First number + * @param {number} b - Second number + * @returns {number} Sum of a and b + */ +function add(a, b) { + return a + b; +} + +// Use arrow functions for callbacks +const numbers = [1, 2, 3]; +const doubled = numbers.map(num => num * 2); + +// Use template literals for string interpolation +console.log(`User ${userName} logged in`); +``` + +### General Guidelines + +- ✅ **Write self-documenting code** with clear variable and function names +- ✅ **Add comments** for complex logic +- ✅ **Keep functions small** and focused on a single task +- ✅ **Use meaningful commit messages** +- ✅ **Test your code** before submitting +- ✅ **Follow DRY principle** (Don't Repeat Yourself) + +## 📝 Commit Message Guidelines + +We follow [Conventional Commits](https://www.conventionalcommits.org/) specification: + +``` +(): + + + +