Merge pull request #502 from milansamuel609/master

Enhances With Best Code Practices, Code Style Guidelines And Acknowledgments

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# How to Contribute
+# How to Contribute 🚀
 
 We warmly welcome all those who wish to contribute to **Online Book Sales**. Whether you're looking to add a new feature or fix a bug, your help is greatly appreciated. Follow the steps below to start contributing:
 
@@ -26,10 +26,10 @@ We warmly welcome all those who wish to contribute to **Online Book Sales**. Whe
 
 6. **Navigate to the project directory**:
     ```bash
-    cd FunwithScience
+    cd OnlineBookSales
     ```
 
-7. **Add a reference(remote) to the original repository**:
+7. **Add a reference (remote) to the original repository**:
     ```bash
     git remote add upstream https://github.com/Trisha-tech/OnlineBookSales.git
     ```
@@ -61,53 +61,56 @@ We warmly welcome all those who wish to contribute to **Online Book Sales**. Whe
 
 13. **Stage your changes**:
     ```bash
-    git add . <\files_that_you_made_changes>
+    git add . <files_that_you_made_changes>
     ```
-    
+
 14. **Commit your changes**:
     ```bash
     git commit -m "relevant message"
     ```
 
 15. **Push the committed changes** in your feature branch to your remote repository.
 
-### Alternatively contribute using GitHub Desktop
+---
+
+### Alternatively Contribute Using GitHub Desktop
 
-1. **Open 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:**
+2. **Clone the Repository:**  
    - If you haven't cloned the OnlineBookSales repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    - Choose the OnlineBookSales repository from the list of repositories on GitHub and clone it to your local machine.
 
-3. **Switch to the Correct Branch:**
+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:**
+4. **Make Changes:**  
    Make your changes to the code or files in the repository using your preferred code editor.
 
-5. **Commit Changes:**
+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 <branch-name>" button to commit your changes to the local branch.
 
-6. **Push Changes to GitHub:**
+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:**
+7. **Create a Pull Request:**  
    - Go to the GitHub website and navigate to your fork of the OnlineBookSales repository.
    - You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
 
-8. **Review and Submit:**
+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:**
+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 OnlineBookSales repository.
 
-⭐️ Support the Project
+⭐️ Support the Project  
 If you find this project helpful, please consider giving it a star on GitHub! Your support helps to grow the project and reach more contributors.
 
+---
 
 # Contributing to OnlineBookSales
 
@@ -135,7 +138,7 @@ The following is a set of guidelines for contributing to OnlineBookSales. These
 
 4. Include any relevant logs or screenshots that can help us understand and reproduce the issue.
 
-5. (Optional)Mention the version of the software you're using and the environment (e.g., operating system, browser) where the issue occurs.
+5. (Optional) Mention the version of the software you're using and the environment (e.g., operating system, browser) where the issue occurs.
 
 ## Pull Requests
 
@@ -167,5 +170,22 @@ The following is a set of guidelines for contributing to OnlineBookSales. These
 
 6. Provide a detailed description of your changes in the pull request.
 
+---
+
+## Best Practices
+
+- **Communicate:** Keep the team informed about your progress and any challenges you face.
+- **Stay Organized:** Use clear commit messages and branch names to maintain a clean project history.
+- **Respect the Codebase:** Follow the established coding practices and structure of the project.
+
+## Code Style Guidelines
+
+- **Indentation:** Use 2 spaces for indentation.
+- **Variable Naming:** Use camelCase for variable names and PascalCase for class names.
+- **Commenting:** Write clear comments for complex logic, and document your code using comments and Markdown where appropriate.
+
+## Acknowledgments
+
+We appreciate all contributions to this project! Your efforts make a significant difference. Special thanks to our contributors for their hard work and dedication.
 
-Remember, contributions are reviewed by project maintainers who might provide feedback or request changes before merging your pull request into the main branch.
+---