From 11c3100bd2f319a531135b9089cd6c4e4561335b Mon Sep 17 00:00:00 2001 From: GauravSahu891 Date: Wed, 23 Oct 2024 20:45:16 +0530 Subject: [PATCH] Improved readability of CONTRIBUTING.md without altering important details --- CONTRIBUTING.md | 38 ++++++++++++++++---------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d4f4d6628..d3a67c737e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,35 +1,35 @@ # Contribution Guidelines 📚 -Welcome to our project! We appreciate your interest and contributions. Please read the following guidelines carefully to ensure a smooth collaboration. +Welcome to Our Project! +Thank you for your interest in contributing! Please read the following guidelines carefully to ensure smooth collaboration. -## General Rules: - -- **Creativity Allowed:** Feel free to submit pull requests that break the rules—we might just merge them anyway! -- **No Build Steps:** Avoid adding build steps like `npm install` to maintain simplicity as a static site. -- **Preserve Existing Content:** Do not remove existing content. -- **Code Style:** Your code can be neat, messy, simple, or complex. As long as it works, it's welcome. -- **Add Your Name:** Remember to add your name to the `contributorsList` file. -- **Keep it Small:** Aim for small pull requests to minimize merge conflicts and streamline reviews. +## General Guidelines: +**Creativity Allowed:** If you have an idea that bends the rules, feel free to submit a pull request (PR). We may still merge it! +**No Build Steps:** Please avoid adding build steps (e.g., npm install). This project is intended to stay simple as a static site. +**Preserve Existing Content:** Ensure you do not remove any existing content. +**Code Style:** Whether your code is clean or messy, simple or complex—it’s all welcome, as long as it works. +**Add Your Name:** Don’t forget to add your name to the contributorsList file. +**Keep it Small:** Try to keep your pull requests small. This helps minimize merge conflicts and makes reviews easier. ## Getting Started 🤩🤗 1. **Fork the Repository:** - - Use the fork button at the top right of the repository page. +- Click the "Fork" button at the top right of the repository page to create your own copy of the project. 2. **Clone Your Fork:** - Clone the forked repository to your local machine. ```bash - git clone https://github.com/fineanmol/Hacktoberfest2024.git + git clone https://github.com/your-username/Hacktoberfest2024.git ``` 3. **Navigate to the Project Directory:** ```bash - cd Hacktoberfest2024 - ``` + cd Hacktoberfest2024 + ``` -4. **Create a New Branch:** + 4. **Create a New Branch:** ```bash git checkout -b my-new-branch @@ -56,11 +56,6 @@ Welcome to our project! We appreciate your interest and contributions. Please re 8. **Create a Pull Request:** - Go to your forked repository on GitHub and create a pull request to the main repository. - -## Avoiding Conflicts {Syncing Your Fork} - -To keep your fork up-to-date with the main repository and avoid conflicts: - 1. **Add Upstream Remote:** ```bash @@ -82,9 +77,8 @@ To keep your fork up-to-date with the main repository and avoid conflicts: This will pull in changes from the parent repository and help you resolve any conflicts. -4. **Keep Updated:** +4. **Stay Updated:** - Regularly pull changes from the upstream repository to keep your fork updated. -We look forward to your contributions and thank you for being a part of our community! - +We appreciate your contributions and are excited to have you as part of our community! Thank you for helping improve our project!