chore: adding contributing guide content from chatgpt (#4)

* chore: adding contributing guide content from chatgpt

* chore: contributing guide docs updated

Author: kunalkeshan

CONTRIBUTING.md

@@ -1 +1,59 @@
 # Contributing Guide
+
+**Table of Contents**:
+
+- [Client](#contributing-to-the-client-side)
+- [Backend](#contributing-to-the-backend-side)
+- [Model](#contributing-to-the-model-side)
+- [Code Style Guidelines](#code-style-guidelines)
+- [Bug Reports & Feature Requests](#bug-reports-and-feature-requests)
+- [Conclusion](#conclusion)
+
+Thank you for your interest in contributing to the Hardware Web UI project! We welcome any contributions, whether they be in the form of bug fixes, feature requests, or new code. This guide will provide you with all the information you need to get started contributing to this project.
+
+## Contributing to the Client Side
+
+The client side of the Hardware Web UI project is built using React and TypeScript. If you would like to contribute to the client side of the project, please follow these steps:
+
+1. Fork the repository and clone your forked repository to your local machine.
+2. Install the required dependencies for the client by running `yarn` or `npm` install inside the client directory.
+3. Make the desired changes to the code.
+4. Run the client using `yarn start` or `npm start` to verify that your changes are working as expected.
+5. Commit your changes and push them to your forked repository.
+6. Open a pull request to the original repository and describe the changes you have made.
+
+## Contributing to the Backend Side
+
+The backend side of the Hardware Web UI project is built using Python and FastAPI. If you would like to contribute to the backend side of the project, please follow these steps:
+
+1. Fork the repository and clone your forked repository to your local machine.
+2. Install the required dependencies for the backend by running `pip install -r requirements.txt`.
+3. Make the desired changes to the code.
+4. Run the server using `py main.py` to verify that your changes are working as expected.
+5. Commit your changes and push them to your forked repository.
+6. Open a pull request to the original repository and describe the changes you have made.
+
+## Contributing to the Model Side
+
+The model used in the Hardware Web UI project is a neural network that detects breast cancer. If you would like to contribute to the model side of the project, please follow these steps:
+
+1. Fork the repository and clone your forked repository to your local machine.
+2. Download the required dataset and trained file from the links provided in the project description.
+3. Use the dataset to train a new model or make changes to the existing model.
+4. Save the new trained model as a `.h5` file in the project root directory.
+5. Make the desired changes to the code.
+6. Run the server using `py main.py` to verify that your changes are working as expected.
+7. Commit your changes and push them to your forked repository.
+8. Open a pull request to the original repository and describe the changes you have made.
+
+## Code Style Guidelines
+
+We follow the PEP 8 style guide for Python code and the Airbnb style guide for JavaScript and TypeScript code. Please make sure that your code adheres to these style guidelines before opening a pull request.
+
+## Bug Reports and Feature Requests
+
+If you find a bug in the project or have a feature request, please open an issue on the project's GitHub page. When reporting a bug, please include as much detail as possible about the issue and steps to reproduce it. When requesting a new feature, please describe the feature in as much detail as possible.
+
+## Conclusion
+
+Thank you for your interest in contributing to the Hardware Web UI project. We appreciate any contributions and look forward to working with you! For any issue or question, feel free to ping me at kunalkeshan12@gmail.com.