diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47e7bbe7..6ac25dac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,72 +1,132 @@ -# ๐Ÿš€ Contributing to "You Don't Need JavaScript" ๐ŸŒ +# ๐Ÿ’–๐Ÿซก Contributing to *You Donโ€™t Need JavaScript* -Thank you for considering lending your expertise to the "You Don't Need JavaScript" project. Your contributions play a vital role in enhancing this resource for developers who wish to craft web features sans JavaScript. Welcome aboard! +Thank you for showing interest in contributing to **You Donโ€™t Need JavaScript!** +Weโ€™re thrilled to have you here โ€” every contribution, big or small, makes this project better and helps inspire developers worldwide to explore whatโ€™s possible without a single line of JavaScript. ๐ŸŒโœจ -Let's navigate through these guidelines for a smooth and collaborative contribution process. +--- -## How to Contribute +## ๐ŸŒŸ Our Vision -๐Ÿ™Œ We're all for contributions, be it bug fixes, feature upgrades, or the introduction of new demos. To get started, follow these steps: +This project is a celebration of the webโ€™s creativity โ€” proving that **HTML and CSS** can achieve stunning, interactive results without relying on JavaScript. +Your ideas, skills, and curiosity make this space thrive. Whether youโ€™re here to fix a typo, design a new demo, or improve existing content, youโ€™re an essential part of this journey. ๐Ÿ’ช๐Ÿ’™ -1. **Fork the Repository:** - - Hit that "Fork" button at the top of this repository. +--- -2. **Clone Your Fork:** - - Bring the repository to your local machine with this command: - ```sh - git clone https://github.com/your-username/You-Dont-Need-JavaScript.git - ``` -3. **Create a New Branch:** - - Forge a new branch for your contribution with a name that paints a picture, e.g., `feature/my-new-demo`. - ```sh - git checkout -b feature/my-new-demo - ``` -4. **Make Your Changes:** - - Work your magic and make the desired changes or additions to the project. -5. **Test Your Changes:** - - Cast a spell of testing to ensure your changes function correctly without introducing any gremlins. -6. **Add Your Work to README:** - - Weave your masterpiece into the README.md following our [Style Guide](README.md#style-guide). -7. **Commit Your Changes:** -- Contribute with meaningful commits that tell the story of your work. +## ๐Ÿ’ฌ Ways to Contribute - ```sh +We welcome contributions of all kinds! You can: - git commit -m "Add a new demo for XYZ feature" +- ๐ŸŽจ Add a **new CSS/HTML-only demo** +- ๐Ÿช„ Enhance or refactor existing examples +- ๐Ÿงน Fix typos, broken links, or formatting +- ๐Ÿ“˜ Improve documentation or readability +- ๐Ÿ’ก Suggest new creative ideas or resources - ``` +> ๐Ÿ’ฌ **Note:** We value clarity, simplicity, and elegance โ€” aim to create something that teaches or inspires. -8. **Push to Your Fork:** +--- - - Send your enchanting changes to your fork on GitHub. +## ๐Ÿชœ Getting Started - ```sh +### 1. Fork & Clone +Start by forking this repository and cloning it to your local system: +```bash +git clone https://github.com//you-dont-need-javascript.git +cd you-dont-need-javascript +``` +### 2. Create a New Branch - git push origin feature/my-new-demo +Create a branch describing your contribution: +```bash +git checkout -b feature/add-css-hover-gallery +``` +### 3. Make Your Changes - ``` -9. **Create a Pull Request (PR):** +Make your edits, build your demo, or enhance documentation. +Please ensure your work: - - Journey to the original repository on GitHub and invoke the "New Pull Request" button. +- Uses no JavaScript - - Craft a clear and concise title and description for your PR. +- Follows clean, consistent HTML/CSS formatting - - Unveil your PR for the grand review. +- Works across modern browsers -10. **Review and Collaboration:** +- Includes clear naming and folder structure - - Join the maintainers in an epic collaboration, addressing feedback or requested changes. +>๐Ÿ’ก Tip: Include a preview GIF or screenshot for visual demos โ€” it helps reviewers and users quickly understand your work. +### 4. Commit Your Work -11. **Your PR is Merged:** +Write meaningful, descriptive commit messages: +```bash +git commit -m "Add: Pure CSS hover gallery demo" +``` +### 5. Push and Create a Pull Request - - Once your PR is approved and merged, your contribution shall be immortalized within the project. +Push your changes and open a PR: +``` bash +git push origin feature/add-css-hover-gallery +``` +Then, visit the main repo on GitHub and click โ€œNew Pull Requestโ€. +Provide a short and clear PR title and description. +--- +### ๐Ÿงฉ Pull Request Review Process +1. Review: A maintainer will review your submission for quality and compatibility. -## Code of Conduct ๐Ÿค +2. Feedback: If suggestions arise, kindly make the requested changes. -Please be aware that we uphold a [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a positive and respectful environment for all contributors. As a participant in this project, you pledge to abide by the Code of Conduct. +3. Merge: Once approved, your contribution will be merged and credited to you. ๐ŸŽ‰ +We appreciate your patience โ€” reviews ensure every addition maintains the projectโ€™s quality and vision. +## ๐Ÿ“œ Contribution Guidelines +| Category | Guideline | +|----------------|------------------------------------------------------------| +| Code Style | Use readable, well-formatted HTML and CSS | +| Design | Keep demos elegant, creative, and responsive | +| Accessibility | Maintain strong contrast and readability | +| Structure | Follow existing folder patterns and naming conventions | +| README Update | Add your demo link and description where relevant | -Let's embark on this collective journey to create a precious resource for developers. Thank you for adding your spark to "You Don't Need JavaScript!" โšก๐ŸŒŸ \ No newline at end of file +### A big thank you to all contributors! ๐Ÿš€ + +

+ + + + + >โœจ Every contribution counts, and your name here represents your spark in this project! +

+ +### ๐Ÿ’ฌ Need Help? + +- If you have questions or want to discuss ideas: + +1. Start a Discussion + +2. Check open Issues + +3. Or reach out via GitHub comments + +Weโ€™re always happy to help and collaborate! ๐Ÿค +# โš–๏ธ Code of Conduct + +Weโ€™re committed to maintaining a welcoming, inclusive environment for everyone. +By participating, you agree to follow our Code of Conduct. + +Please treat others with kindness, patience, and respect โ€” every contributor deserves it. ๐Ÿ’› + +
+ +โญ **Star this repository** to show support +๐Ÿ’ฌ **Share your demos** with the community +๐Ÿ’ก **Spread the message:** creativity doesnโ€™t always need JavaScript! + +๐Ÿ’– **Thank You, Contributor!** + +Your contribution is more than just code โ€” +itโ€™s creativity, passion, and collaboration in motion. +Together, weโ€™re proving that the web can be magical โ€” even without JavaScript. + +