From c353f187adcc3ca3c4f0a28e015205c07a24735c Mon Sep 17 00:00:00 2001 From: Milan P Samuel Date: Sat, 26 Oct 2024 10:41:07 +0530 Subject: [PATCH] Done the enhancements and also addded some new sections --- CONTRIBUTING.md | 258 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 216 insertions(+), 42 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6bde8b8..fea35f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,82 +1,256 @@ -# Contributing to ChaosWeb +# Contributing to ChaosWeb 🎯 πŸŽ‰ **Welcome, brave developer!** πŸŽ‰ Thank you for your interest in contributing to **ChaosWeb**, the most chaotic UI/UX experiment on the internet. We believe that sometimes breaking the rules can lead to innovative and fun discoveries. Whether you're here to fix a bug, suggest a new feature, or add more chaos to the project, your contributions are highly appreciated! -## πŸ“ How to Contribute +
-### 1. Fork the Repository -- Start by forking this repository to your GitHub account. -- This creates your own copy of the project, where you can make and test changes. +# Code of Conduct πŸ“ƒ -### 2. Clone the Repository -- Clone the repository to your local machine for development. +Please read and follow our [Code of Conduct.](https://github.com/vansh-codes/ChaosWeb/blob/main/CODE_OF_CONDUCT.md) + +
+ +#

Star our Repository ⭐

+ +###
[![Stars](https://img.shields.io/github/stars/vansh-codes/ChaosWeb?style=for-the-badge&logo=github)](https://github.com/vansh-codes/ChaosWeb/stargazers) [![Forks](https://img.shields.io/github/forks/vansh-codes/ChaosWeb?style=for-the-badge&logo=github)](https://github.com/vansh-codes/ChaosWeb/network/members) [![Issues](https://img.shields.io/github/issues/vansh-codes/ChaosWeb?style=for-the-badge&logo=github)](https://github.com/vansh-codes/ChaosWeb/issues) [![PRs Open](https://img.shields.io/github/issues-pr/vansh-codes/ChaosWeb?style=for-the-badge&logo=github)](https://github.com/vansh-codes/ChaosWeb/pulls) [![PRs Closed](https://img.shields.io/github/issues-pr-closed/vansh-codes/ChaosWeb?style=for-the-badge&logo=github&color=2cbe4e)](https://github.com/vansh-codes/ChaosWeb/pulls?q=is%3Apr+is%3Aclosed)
+ +
+ +# Need Help With The Basics? πŸ€” + +If you're new to Git and GitHub, no worries! Here are some useful resources: + +- [Forking a Repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) +- [Cloning a Repository](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) +- [How to Create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) +- [Getting Started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) +- [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources) + +
+ +# Project Structure πŸ“‚ ```bash -git clone https://github.com/YourUsername/ChaosWeb.git +ChaosWeb/ +β”œβ”€β”€ .github/ # GitHub-related configurations such as workflows, issue templates, etc +β”‚ +β”œβ”€β”€ assets/ # Some images +β”‚ +β”œβ”€β”€ chaosweb-v@2/ # Contains index.html and also some core components of the project +β”‚ +β”œβ”€β”€ css/ # Contains stylesheet files +β”‚ +β”œβ”€β”€ js/ # Contains javascript files +β”‚ +β”œβ”€β”€ node_modules/ # Contains the integrity files +β”‚ +β”œβ”€β”€ sfx/ # Contains sound effects +β”‚ +β”œβ”€β”€ .gitignore +β”‚ +β”œβ”€β”€ 3d-effect-hypnosis-spiral-vector-7844424.jpg +β”‚ +β”œβ”€β”€ chaos.html +β”‚ +β”œβ”€β”€ CODE_OF_CONDUCT.md # Some rules for contributors +β”œβ”€β”€ +β”œβ”€β”€ ContactUs.html # Contains the contact us page +β”œβ”€β”€ +β”œβ”€β”€ CONTRIBUTING.md # Instructions for the contributors +β”œβ”€β”€ +β”œβ”€β”€ emojiland.html +β”œβ”€β”€ +β”œβ”€β”€ hypnotic.html +β”œβ”€β”€ +β”œβ”€β”€ IMG_20241015_121622.jpg +β”œβ”€β”€ +β”œβ”€β”€ index.html # The main .html page +β”œβ”€β”€ +β”œβ”€β”€ LICENSE # A permission to do something +β”œβ”€β”€ +β”œβ”€β”€ maze.html +β”œβ”€β”€ +β”œβ”€β”€ night_time.html +β”œβ”€β”€ +β”œβ”€β”€ package-lock.json +β”œβ”€β”€ +β”œβ”€β”€ preloader.js +β”œβ”€β”€ +β”œβ”€β”€ preloaderStyle.css +β”œβ”€β”€ +β”œβ”€β”€ README.md # Some instructions related to the contributions +β”œβ”€β”€ +β”œβ”€β”€ SECURITY.md +β”œβ”€β”€ +β”œβ”€β”€ signup.html +β”œβ”€β”€ +β”œβ”€β”€ Simongame.html +β”œβ”€β”€ +β”œβ”€β”€ style1.css +β”œβ”€β”€ +β”œβ”€β”€ testing.html +β”œβ”€β”€ +β”œβ”€β”€ Timeline.html +β”œβ”€β”€ +β”œβ”€β”€ yarn.lock ``` -### 3. Create a Branch -- Create a new branch specific to the feature or fix you’re working on. Keep it organized by using descriptive names, such as: +
+ +# First Pull Request ✨ + +1. **Star this repository** + Click on the top right corner marked as **Stars** at last. + +2. **Fork this repository** + Click on the top right corner marked as **Fork** at second last. + +3. **Clone the forked repository** + +```bash +git clone https://github.com//ChaosWeb.git +``` + +4. **Navigate to the project directory** ```bash -git checkout -b feature-add-random-movement +cd ChaosWeb ``` -### 4. Commit Your Changes -- Add and commit your changes with meaningful commit messages. +5. **Create a new branch** + +```bash +git checkout -b +``` + +6. **To make changes** ```bash git add . -git commit -m "Added random movement for elements" ``` -### 5. Push Your Branch -- Push your branch to your forked repository. +7. **Now to commit** + +```bash +git commit -m "add comment according to your changes or addition of features inside this" +``` + +8. **Push your local commits to the remote repository** + ```bash -git push origin feature-add-random-movement +git push -u origin ``` -### 6. Open a Pull Request +9. **Create a Pull Request** + +10. **Congratulations! πŸŽ‰ you've made your contribution** + +
+ +# Alternatively, contribute using GitHub Desktop πŸ–₯️ + +1. **Open GitHub Desktop:** + Launch GitHub Desktop and log in to your GitHub account if you haven't already. + +2. **Clone the Repository:** +- If you haven't cloned the project repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository." +- Choose the project repository from the list of repositories on GitHub and clone it to your local machine. + +3.**Switch to the Correct Branch:** +- Ensure you are on the branch that you want to submit a pull request for. +- If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch. + +4. **Make Changes:** +- Make your changes to the code or files in the repository using your preferred code editor. + +5. **Commit Changes:** +- In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit. +- Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch. + +6. **Push Changes to GitHub:** +- After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub. + +7. **Create a Pull Request:** +- Go to the GitHub website and navigate to your fork of the project repository. +- You should see a button to "Compare & pull request" between your fork and the original repository. Click on it. + +8. **Review and Submit:** +- On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request. +- Once you're satisfied, click the "Create pull request" button to submit your pull request. + +9. **Wait for Review:** +Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the project repository. + +
+ +# For Help And Support πŸ’¬ + +- Admin Github Profile:- [Vansh Chaurasiya](https://github.com/vansh-codes) +- Contact :- [LinkedIn](https://linkedin.com/in/vanshchaurasiya24) + +
+ +# Good Coding Practices πŸ§‘β€πŸ’» + +1. **Follow the Project's Code Style** + + - Maintain consistency with the existing code style (indentation, spacing, comments). + - Use meaningful and descriptive names for variables, functions, and classes. + - Keep functions short and focused on a single task. + - Avoid hardcoding values; instead, use constants or configuration files when possible. + +2. **Write Clear and Concise Comments** + + - Use comments to explain why you did something, not just what you did. + - Avoid unnecessary comments that state the obvious. + - Document complex logic and functions with brief explanations to help others understand your thought -process. -- Open a pull request from your branch into the `main` branch of this repository. -- Be sure to explain what your changes do, why they're needed, and any potential issues they might cause. +3. **Keep Code DRY (Don't Repeat Yourself)** -### 7. Wait for Review + - Avoid duplicating code. Reuse functions, methods, and components whenever possible. + - If you find yourself copying and pasting code, consider creating a new function or component. -- One of the project maintainers will review your pull request and provide feedback or merge it if all looks good! +4. **Write Tests** -## πŸ§ͺ Adding New Features + - Write unit tests for your functions and components. + - Ensure your tests cover both expected outcomes and edge cases. + - Run tests locally before making a pull request to make sure your changes don’t introduce new bugs. -### Want to make ChaosWeb even more chaotic? +5. **Code Reviews and Feedback** -- Feel free to experiment with wild and unconventional ideas! -- All ideas are welcome, but remember, **ChaosWeb’s goal is to confuse and entertain**, so your features should align with this purpose. + - Be open to receiving constructive feedback from other contributors. + - Conduct code reviews for others and provide meaningful suggestions to improve the code. + - Always refactor your code based on feedback to meet the project's standards. +
-Please create an issue before working on any major new feature so we can discuss it! +# Pull Request Process πŸš€ -## πŸ› Reporting Bugs +When submitting a pull request, please adhere to the following: -Even chaos has bugs! If you find something that’s not working as intended (or too well-ordered for ChaosWeb standards): +1. **Self-review your code** before submission. πŸ˜€ +2. Include a detailed description of the functionality you’ve added or modified. +3. Comment your code, especially in complex sections, to aid understanding. +4. Add relevant screenshots to assist in the review process. +5. Submit your PR using the provided template and hang tight; we'll review it as soon as possible! πŸš€ -- Open an issue with a clear description of the problem. -- Include steps to reproduce the bug, along with screenshots or other relevant info. +
-## 🌟 Code Style Guide +# Issue Report Process πŸ“Œ -- **HTML/CSS**: Clean, well-indented, and readable. -- **JavaScript**: Use `const` and `let` over `var`. Keep functions small and modular. -- **Comments**: Comment any tricky or confusing code to help future contributors. +To report an issue, follow these steps: -## ⚠️ Code of Conduct +1. Navigate to the project's issues section :- [Issues](https://github.com/vansh-codes/ChaosWeb/issues/new/choose) +2. Please kindly choose the appropriate template according to your issue. +3. Provide a clear and concise description of the issue. +4. Wait until someone looks into your report. +5. Begin working on the issue only after you have been assigned to it. πŸš€ -**Please be kind and respectful when contributing. The goal is to learn, have fun, and create something truly chaotic together!** +
-## πŸ’‘ Ideas for First Contributions +# Thank you for contributing πŸ’— -If you’re new to the project, consider starting with one of these beginner-friendly tasks: +We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! πŸš€ -- Fix typos or improve documentation. -- Tweak the randomness of an element's behavior. -- Add new unpredictable animations or UI elements. +## \ No newline at end of file