diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md deleted file mode 100644 index 3a363a8..0000000 --- a/.github/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,127 +0,0 @@ -# Code of Conduct - -## Our Pledge - -We as contributors, maintainers, and members of the Hacktoberfest-Html_CSS_JS community pledge to make participation in our project a respectful, harassment-free, and inclusive experience for everyone. Our goal is to build an open, supportive, and creative environment that encourages collaboration and innovation. - -We are committed to providing a welcoming and inspiring community for people of all backgrounds and identities, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, nationality, personal appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -To create a positive environment, we expect the following behaviors: - -### Examples of positive behavior include: - -- Demonstrating empathy, kindness, and respect toward others -- Giving and gracefully accepting constructive feedback -- Using welcoming and inclusive language -- Focusing on what is best for the community -- Showing appreciation for others' contributions -- Being patient with newcomers and those learning -- Encouraging questions and providing helpful answers -- Celebrating diversity and different perspectives -- Taking responsibility for our actions and their impact - -### Examples of unacceptable behavior include: - -- The use of sexualized language or imagery, or any sexual attention or advances -- Trolling, insulting, or derogatory comments, and personal or political attacks -- Public or private harassment, threats, or intimidation -- Publishing others' private information (e.g., physical or email addresses) without explicit permission -- Any other conduct that could reasonably be considered inappropriate in a professional setting -- Dismissive or disrespectful comments about programming languages, tools, or approaches -- Spamming, excessive self-promotion, or off-topic discussions -- Discrimination based on any protected characteristic -- Encouraging or inciting violence or harassment - -## Scope - -This Code of Conduct applies within project spaces (e.g., GitHub repositories, discussions, and communication channels) and in public spaces when an individual is representing the project or community. Examples include: - -- Posting via official project social media accounts -- Representing the project at a community event -- Contributing to project documentation or code -- Participating in project discussions or issues - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at **harshitpachori345@gmail.com**. All complaints will be reviewed, investigated, and handled fairly and confidentially. - -The project team is obligated to respect the privacy and security of the reporter of any incident. We will not disclose the identity of reporters unless they explicitly consent. - -### Reporting Process - -1. **Document the incident**: Include screenshots, links, or other evidence when possible -2. **Contact the maintainers**: Send details to harshitpachori345@gmail.com -3. **Response timeline**: We aim to respond within 48 hours -4. **Investigation**: The team will review and investigate the report -5. **Resolution**: Appropriate action will be taken based on the severity - -## Enforcement Guidelines - -The project team will use the following guidelines to determine appropriate consequences for violations: - -### 1. Correction -- **Use case**: Minor violations or first-time offenses -- **Action**: Maintainers will provide feedback privately, explaining the violation and expected behavior -- **Resolution**: A sincere apology and correction will typically resolve minor issues - -### 2. Warning -- **Use case**: Continued violations or more serious first-time offenses -- **Action**: A formal warning will be issued with specific consequences outlined -- **Resolution**: Clear expectations for future behavior will be established - -### 3. Temporary Ban -- **Use case**: More severe or repeated violations -- **Action**: Temporary exclusion from project spaces (issues, PRs, discussions) -- **Duration**: Typically 1-4 weeks depending on severity -- **Resolution**: Reinstatement after demonstrating improved behavior - -### 4. Permanent Ban -- **Use case**: Severe or consistent violations -- **Action**: Permanent removal from the project and community spaces -- **Resolution**: No reinstatement without exceptional circumstances - -## Community Guidelines - -### For Contributors -- Be respectful and constructive in all interactions -- Help newcomers feel welcome and supported -- Focus on the code and ideas, not the person -- Use clear, descriptive commit messages and PR descriptions -- Test your changes thoroughly before submitting - -### For Maintainers -- Lead by example in following this code of conduct -- Be proactive in addressing potential issues -- Provide clear, constructive feedback -- Recognize and appreciate contributions -- Make decisions in the best interest of the community - -### For Users -- Report bugs and issues constructively -- Be patient with development timelines -- Provide helpful feedback and suggestions -- Respect the time and effort of contributors -- Follow platform guidelines and terms of service - -## Support and Resources - -If you need help or have questions about this Code of Conduct: - -- **Email**: harshitpachori345@gmail.com -- **Community**: Join our discussions on GitHub - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html). - -It is also inspired by best practices from open-source communities such as: -- [Python Software Foundation](https://www.python.org/psf/codeofconduct/) -- [Node.js Foundation](https://github.com/nodejs/admin/blob/main/CODE_OF_CONDUCT.md) -- [Kubernetes Community](https://github.com/kubernetes/community/blob/master/code-of-conduct.md) - ---- - -**Remember**: We're all here to learn, build, and create amazing things together. -Let's make Hacktoberfest-Html_CSS_JS a place where everyone feels welcome and empowered to contribute! ๐Ÿš€ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index 69733dd..0000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,155 +0,0 @@ -# ๐Ÿงฉ Contributing Guidelines - -Thank you for your interest in contributing to **Hacktoberfest-Html_CSS_JS!** -This repository is created to help beginners make their first open-source contributions during **Hacktoberfest** ๐ŸŽ‰ - -
- -## ๐Ÿ“ Repository Structure - -```bash -โ”‚ -โ”œโ”€โ”€ .github/ # Github meta files directory -โ”‚ โ””โ”€โ”€ CODE_OF_CONDUCT.md # Code of Conduct -โ”‚ โ””โ”€โ”€ CONTRIBUTING.md # Contribution Guideline -โ”‚ -โ”œโ”€โ”€ html/ # html files directory -โ”‚ โ””โ”€โ”€ index.html # Main html file -โ”‚ -โ”œโ”€โ”€ css/ # CSS stylesheets directory -โ”‚ โ””โ”€โ”€ style.css # Main stylesheet -โ”‚ -โ”œโ”€โ”€ js/ # JavaScript files directory -โ”‚ โ””โ”€โ”€ script.js # Main JavaScript file -โ”‚ -โ”œโ”€โ”€ dsa/ # DSA directory -โ”‚ โ””โ”€โ”€ binary_search.js # DSA files -โ”‚ -โ””โ”€โ”€ README.md # Project documentation -``` - - -Each folder contains small, beginner-friendly projects. -You can contribute to **any folder** depending on your interest. - ---- -
- -## ๐Ÿš€ How to Contribute - -Follow these simple steps to make your contribution count for **Hacktoberfest** ๐ŸŒฑ - -### 1๏ธโƒฃ Fork the Repository - -Click the **Fork** button (top-right corner of the repo) -This creates your personal copy of the repository. - -
- -### 2๏ธโƒฃ Clone Your Fork - -Clone the forked repo to your local machine: - -```bash -git clone https://github.com//Hacktoberfest-Html_CSS_JS.git -``` -Move into the folder: - -```bash -cd Hacktoberfest-Html_CSS_JS -``` - -
- -### 3๏ธโƒฃ Create a New Branch - -Always create a new branch for your contribution: -```bash -git checkout -b my-new-feature -``` -Example: -```bash -git checkout -b add-responsive-navbar -``` - -
- -### 4๏ธโƒฃ Add Your Project or Code - -Depending on your contribution type: - -#### โžค For HTML/CSS/JS Projects -- Add your files to the correct folder (`html/`, `css/`, or `js/`). -- Use **clear folder and file names** (e.g. `login-form`, `weather-app`, `button-hover-effect`). - - -#### โžค For DSA Problems -- Add your `.js`, `.cpp`, or `.py` file under the `dsa/` folder. -- Follow the naming convention: `problem-name_language.extension` - - Example: `binary-search_js.js` - -
- -### 5๏ธโƒฃ Commit Your Changes -```bash -git add . -git commit -m "Added my new project: responsive navbar" -``` -
- -### 6๏ธโƒฃ Push to Your Fork -```bash -git push origin my-new-feature -``` - -
- -### 7๏ธโƒฃ Create a Pull Request (PR) - -- Go to your forked repository on GitHub. -- Click **โ€œCompare & Pull Requestโ€**. -- Add a clear title and short description of your changes. -- Submit your PR. - -Once reviewed and approved, your PR will be merged. - ---- - -## Contribution Rules - - -- Each contribution should be **unique** (avoid duplicates). -- Your project must run properly and be well-structured. -- Add a short `README.md` file inside your project folder(if possible) explaining: - - What your project does - - How to run it - - Author name (optional) - ---- - -## Hacktoberfest Notes - -- Make sure you have registered at [hacktoberfest.com](https://hacktoberfest.com/). -- Ensure your pull requests follow the repository guidelines and are **genuine**. -- Avoid spammy or irrelevant pull requests, as they may be marked **invalid** and will not count toward Hacktoberfest. -- You can contribute multiple valid PRs to different repositories to complete your Hacktoberfest goals. -- Review others' PRs respectfully and help maintainers keep the repo organized. - - -## Need Help? - -If you face any issue: - -- Check existing issues or open a new one. -- Be polite and descriptive. -- Maintain respectful communication. - -Let's learn, code, and grow together. - -Happy Coding! - ---- - -**Maintainer:** [@HarshitPachori](https://github.com/HarshitPachori) -**Repository:** [Hacktoberfest-Html_CSS_JS](https://github.com/HarshitPachori/Hacktoberfest-Html_CSS_JS) - diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml new file mode 100644 index 0000000..d1646ac --- /dev/null +++ b/.github/workflows/greetings.yml @@ -0,0 +1,44 @@ +name: Greetings + +on: [pull_request_target, issues] + +jobs: + greeting: + runs-on: ubuntu-latest + permissions: + issues: write + pull-requests: write + steps: + - uses: actions/first-interaction@v1 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + issue-message: | + ๐Ÿ‘‹ Hi there! Thank you for opening your first issue on this project! + + We appreciate you taking the time to contribute to our community. ๐ŸŽ‰ + + A maintainer will review your issue and respond as soon as possible. In the meantime, please make sure you've provided all the necessary information. + + If you have any questions, feel free to ask in the comments below. + + Happy coding! ๐Ÿš€ + + --- + **Maintainers:** @HarshitPachori @ayushHardeniya + pr-message: | + ๐ŸŽ‰ Congratulations on opening your first Pull Request! + + Thank you for contributing to our project! We're excited to review your contribution. ๐ŸŒŸ + + **Before your PR is reviewed, please make sure:** + - โœ… Your code follows our style guidelines + - โœ… You've tested your changes + - โœ… You've updated relevant documentation + - โœ… All CI checks pass + + A maintainer will review your PR soon. Please be patient and feel free to ask questions in the comments if needed. + + Don't forget to add yourself to `Contributor.md` once your PR is merged! ๐ŸŽŠ + + --- + **Maintainers:** @HarshitPachori @ayushHardeniya \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4d6fe35 --- /dev/null +++ b/.gitignore @@ -0,0 +1,107 @@ +# Dependencies +node_modules/ +npm-debug.log* +yarn-debug.log* +yarn-error.log* +package-lock.json +yarn.lock +pnpm-lock.yaml + +# Build outputs +dist/ +build/ +out/ +.next/ +.nuxt/ +.cache/ +.parcel-cache/ + +# IDE and Editor files +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +.idea/ +*.swp +*.swo +*~ +.project +.classpath +.settings/ +*.sublime-project +*.sublime-workspace + +# OS generated files +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db +desktop.ini + +# Logs +logs/ +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +pids/ +*.pid +*.seed +*.pid.lock + +# Environment variables +.env +.env.local +.env.development.local +.env.test.local +.env.production.local +.env*.local + +# Testing +coverage/ +.nyc_output/ +*.lcov +.jest/ + +# Temporary files +tmp/ +temp/ +*.tmp + +# Compiled files +*.com +*.class +*.dll +*.exe +*.o +*.so +*.obj + +# Archives +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip + +# Database +*.sql +*.sqlite +*.db + +# Misc +.sass-cache/ +connect.lock +typings/ +.npm +.eslintcache +.node_repl_history +.yarn-integrity \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..2f014ea --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,24 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "name": "C/C++ Runner: Debug Session", + "type": "cppdbg", + "request": "launch", + "args": [], + "stopAtEntry": false, + "externalConsole": true, + "cwd": ".", + "program": "build/Debug/outDebug", + "MIMode": "gdb", + "miDebuggerPath": "gdb", + "setupCommands": [ + { + "description": "Enable pretty-printing for gdb", + "text": "-enable-pretty-printing", + "ignoreFailures": true + } + ] + } + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..b42a89b --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,61 @@ +{ + "C_Cpp_Runner.cCompilerPath": "C:/Program Files/DevVerse/MinGW/bin/gcc.exe", + "C_Cpp_Runner.cppCompilerPath": "C:/Program Files/DevVerse/MinGW/bin/g++.exe", + "C_Cpp_Runner.debuggerPath": "C:/Program Files/DevVerse/MinGW/bin/gdb.exe", + "C_Cpp_Runner.cStandard": "", + "C_Cpp_Runner.cppStandard": "", + "C_Cpp_Runner.msvcBatchPath": "C:/Program Files/Microsoft Visual Studio/VR_NR/Community/VC/Auxiliary/Build/vcvarsall.bat", + "C_Cpp_Runner.useMsvc": false, + "C_Cpp_Runner.warnings": [ + "-Wall", + "-Wextra", + "-Wpedantic", + "-Wshadow", + "-Wformat=2", + "-Wcast-align", + "-Wconversion", + "-Wsign-conversion", + "-Wnull-dereference" + ], + "C_Cpp_Runner.msvcWarnings": [ + "/W4", + "/permissive-", + "/w14242", + "/w14287", + "/w14296", + "/w14311", + "/w14826", + "/w44062", + "/w44242", + "/w14905", + "/w14906", + "/w14263", + "/w44265", + "/w14928" + ], + "C_Cpp_Runner.enableWarnings": true, + "C_Cpp_Runner.warningsAsError": false, + "C_Cpp_Runner.compilerArgs": [], + "C_Cpp_Runner.linkerArgs": [], + "C_Cpp_Runner.includePaths": [ + "${workspaceFolder}/**" + ], + "C_Cpp_Runner.includeSearch": [ + "*", + "**/*" + ], + "C_Cpp_Runner.excludeSearch": [ + "**/build", + "**/build/**", + "**/.*", + "**/.*/**", + "**/.vscode", + "**/.vscode/**" + ], + "C_Cpp_Runner.useAddressSanitizer": false, + "C_Cpp_Runner.useUndefinedSanitizer": false, + "C_Cpp_Runner.useLeakSanitizer": false, + "C_Cpp_Runner.showCompilationTime": false, + "C_Cpp_Runner.useLinkTimeOptimization": false, + "C_Cpp_Runner.msvcSecureNoWarnings": false +} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..68ccc6e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,117 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +- Initial project structure +- Complete open-source documentation suite + +--- + +## [1.0.0] - 2024-11-04 + +### ๐ŸŽ‰ Initial Release + +#### Added +- โœจ Core HTML, CSS, and JavaScript directories +- ๐Ÿ“š DSA implementations in JavaScript, C++, and Java +- ๐ŸŽจ Design patterns directory structure +- ๐Ÿ› ๏ธ Tools and utilities directory +- ๐Ÿ“– Comprehensive README.md +- ๐Ÿ“‹ CODE_OF_CONDUCT.md +- ๐Ÿค CONTRIBUTING.md +- ๐Ÿ”’ SECURITY.md +- ๐Ÿ“ REPOSITORY_STRUCTURE.md +- ๐Ÿ‘ฅ Contributor.md +- ๐Ÿ“œ MIT LICENSE +- ๐Ÿ”ง .gitignore configuration +- ๐Ÿ“‚ .github directory with templates +- ๐Ÿ’ป .vscode workspace settings + +#### Documentation +- Complete contribution guidelines +- Repository structure documentation +- Security policy +- Code of conduct based on Contributor Covenant +- Issue and PR templates + +#### Infrastructure +- GitHub Actions workflow setup +- VS Code configuration +- Development environment guidelines + +--- + +## How to Use This Changelog + +### Types of Changes +- `Added` for new features +- `Changed` for changes in existing functionality +- `Deprecated` for soon-to-be removed features +- `Removed` for now removed features +- `Fixed` for any bug fixes +- `Security` for vulnerability fixes + +### Version Format +- **Major version** (X.0.0): Breaking changes +- **Minor version** (0.X.0): New features, backwards compatible +- **Patch version** (0.0.X): Bug fixes, backwards compatible + +### Example Entry Format + +```markdown +## [X.Y.Z] - YYYY-MM-DD + +### Added +- New feature description (#PR-number) +- Another feature by @username + +### Changed +- Modified behavior description (#PR-number) + +### Fixed +- Bug fix description by @username (#PR-number) + +### Security +- Security patch description +``` + +--- + +## Contribution Guidelines + +When contributing, please update this changelog: + +1. Add your changes under `[Unreleased]` section +2. Use the appropriate category (Added, Changed, Fixed, etc.) +3. Include PR number and/or GitHub username +4. Keep descriptions concise and clear + +Example: +```markdown +## [Unreleased] + +### Added +- Responsive navigation menu component (#42) by @johndoe +- Dark mode toggle feature (#45) + +### Fixed +- Mobile menu overlay issue (#43) by @janedoe +``` + +--- + +## Links + +- [Repository](https://github.com/HarshitPachori/Hacktoberfest-Html_CSS_JS) +- [Issues](https://github.com/HarshitPachori/Hacktoberfest-Html_CSS_JS/issues) +- [Pull Requests](https://github.com/HarshitPachori/Hacktoberfest-Html_CSS_JS/pulls) + +--- + +**Maintained by:** Harshit Pachori ([@HarshitPachori](https://github.com/HarshitPachori)) & Ayush Sharma ([@ayushHardeniya](https://github.com/ayushHardeniya)) \ No newline at end of file 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: + +``` +(): + + + +