Enhanced by adding Best Practices, Code Style Guidelines and Acknowle…

…dgements
Trisha-tech · Oct 16, 2024 · e25c55e · e25c55e
1 parent 19ee775
commit e25c55e
Showing 1 changed file with 141 additions and 100 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,150 +1,191 @@
-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:
+# How to Contribute 🚀
 
-Getting Started
-Create a folder at your desired location (usually on your desktop).
+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:
 
-Open Git Bash in the new folder.
+## Getting Started
 
-Initialize a Git repository by running the command:
+1. **Create a folder** at your desired location (usually on your desktop).
 
-bash
-Copy code
-git init
-Forking and Cloning the Repository
-Fork the repository on GitHub.
+2. **Open Git Bash** in the new folder.
 
-Clone your forked repository of the project using:
+3. **Initialize a Git repository** by running the command:
+    ```bash
+    git init
+    ```
 
-bash
-Copy code
-git clone https://github.com/<your_username>/OnlineBookSales.git
-Setting Upstream and Updating Your Fork
-Navigate to the project directory:
+## Forking and Cloning the Repository
 
-bash
-Copy code
-cd OnlineBookSales
-Add a reference (remote) to the original repository:
+4. **Fork the repository** on GitHub.
 
-bash
-Copy code
-git remote add upstream https://github.com/Trisha-tech/OnlineBookSales.git
-Check the remotes for this repository:
+5. **Clone your forked repository** of the project using:
+    ```bash
+    git clone https://github.com/<your_username>/OnlineBookSales.git
+    ```
 
-bash
-Copy code
-git remote -v
-Update your fork with the latest changes from the upstream repository:
+## Setting Upstream and Updating Your Fork
 
-bash
-Copy code
-git pull upstream main
-Making Changes
-Create a new branch (prefer a branch name that relates to your assigned issue):
+6. **Navigate to the project directory**:
+    ```bash
+    cd OnlineBookSales
+    ```
 
-bash
-Copy code
-git checkout -b <YOUR_BRANCH_NAME>
-Make your desired changes to the codebase.
+7. **Add a reference (remote) to the original repository**:
+    ```bash
+    git remote add upstream https://github.com/Trisha-tech/OnlineBookSales.git
+    ```
 
-Check your changes:
+8. **Check the remotes for this repository**:
+    ```bash
+    git remote -v
+    ```
 
-bash
-Copy code
-git status
-git diff
-Stage your changes:
+9. **Update your fork** with the latest changes from the upstream repository:
+    ```bash
+    git pull upstream main
+    ```
 
-bash
-Copy code
-git add <files_that_you_made_changes>
-Commit your changes:
+## Making Changes
 
-bash
-Copy code
-git commit -m "A relevant message"
-Push the committed changes in your feature branch to your remote repository.
+10. **Create a new branch** (prefer a branch name that relates to your assigned issue):
+    ```bash
+    git checkout -b <YOUR_BRANCH_NAME>
+    ```
 
-Alternatively, Contribute Using GitHub Desktop
-Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.
+11. **Make your desired changes** to the code base.
 
-Clone the Repository:
+12. **Check your changes**:
+    ```bash
+    git status
+    git diff
+    ```
 
-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.
-Switch to the Correct Branch:
+13. **Stage your changes**:
+    ```bash
+    git add . <files_that_you_made_changes>
+    ```
 
-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.
-Make Changes: Make your changes to the code or files in the repository using your preferred code editor.
+14. **Commit your changes**:
+    ```bash
+    git commit -m "relevant message"
+    ```
 
-Commit Changes:
+15. **Push the committed changes** in your feature branch to your remote repository.
 
-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.
-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.
+---
 
-Create a Pull Request:
+### Alternatively Contribute Using GitHub Desktop
 
-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.
-Review and Submit:
+1. **Open GitHub Desktop:**  
+   Launch GitHub Desktop and log in to your GitHub account if you haven't already.
 
-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.
-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.
+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.
 
-⭐️ Support the Project
+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 <branch-name>" 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 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:**  
+   - 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 OnlineBookSales repository.
+
+⭐️ 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
+---
+
+# Contributing to OnlineBookSales
+
 First off, thanks for taking the time to contribute! 🎉
 
 The following is a set of guidelines for contributing to OnlineBookSales. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
 
-Reporting Issues
-Before You Submit an Issue
-Check the existing issues to see if your issue has already been reported. Duplicate issues clutter the issue tracker and make it harder for us to prioritize issues.
+## Reporting Issues
+
+### Before You Submit an Issue
+
+1. Check the existing issues to see if your issue has already been reported. Duplicate issues clutter the issue tracker and make it harder for us to prioritize issues.
+
+2. Search through open and closed issues to see if your issue has already been addressed.
+
+3. Review the project documentation to ensure your issue hasn't already been covered.
+
+### How to Submit an Issue
+
+1. Use a clear and descriptive title for the issue to identify the problem.
+
+2. Describe the exact steps to reproduce the problem. Include code snippets or links to a repository, if applicable.
+
+3. Explain the expected behavior and what actually happens.
+
+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.
+
+## Pull Requests
+
+### Before You Submit a Pull Request
+
+1. Ensure that your changes are aligned with the project's goals and codebase.
+
+2. Write clear and concise commit messages and add the issue number where you were assigned the task (for clarity).
 
-Search through open and closed issues to see if your issue has already been addressed.
+3. Test your changes thoroughly.
 
-Review the project documentation to ensure your issue hasn't already been covered.
+4. Update the documentation if your changes require it.
 
-How to Submit an Issue
-Use a clear and descriptive title for the issue to identify the problem.
+5. Ensure there are no merge conflicts with the base branch.
 
-Describe the exact steps to reproduce the problem. Include code snippets or links to a repository, if applicable.
+6. Only submit a pull request for issues that have been assigned to you or if the issue is not assigned to anyone else. Someone else might be working on an issue that has been assigned to them, so it’s important to avoid duplicating efforts.
 
-Explain the expected behavior and what actually happens.
+### Submitting a Pull Request
 
-Include any relevant logs or screenshots that can help us understand and reproduce the issue.
+1. Create a new branch for your work.
 
-(Optional) Mention the version of the software you're using and the environment (e.g., operating system, browser) where the issue occurs.
+2. Make your changes on this branch.
 
-Pull Requests
-Before You Submit a Pull Request
-Ensure that your changes align with the project's goals and codebase.
+3. Commit your changes with a clear message.
 
-Write clear and concise commit messages and add the issue number where you were assigned the task (for clarity).
+4. Push your changes to your fork on GitHub.
 
-Test your changes thoroughly.
+5. Create a pull request from your fork's branch to the original repository's main branch.
 
-Update the documentation if your changes require it.
+6. Provide a detailed description of your changes in the pull request.
 
-Ensure there are no merge conflicts with the base branch.
+---
 
-Only submit a pull request for issues that have been assigned to you or if the issue is not assigned to anyone else. Someone else might be working on an issue that has been assigned to them, so it’s important to avoid duplicating efforts.
+## Best Practices
 
-Submitting a Pull Request
-Create a new branch for your work.
+- **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.
 
-Make your changes on this branch.
+## Code Style Guidelines
 
-Commit your changes with a clear message.
+- **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.
 
-Push your changes to your fork on GitHub.
+## Acknowledgments
 
-Create a pull request from your fork's branch to the original repository's main branch.
+We appreciate all contributions to this project! Your efforts make a significant difference. Special thanks to our contributors for their hard work and dedication.
 
-Provide a detailed description of your changes in the pull request.
+---