{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Contribution Guidelines\n",
    "\n",
    "We welcome contributions to our project! To maintain a high standard of quality, we have a set of guidelines and processes for making contributions. Please follow these guidelines to ensure your contributions can be easily reviewed and accepted.\n",
    "\n",
    "## Table of Contents\n",
    "\n",
    "1. [Getting Started](#getting-started)\n",
    "2. [How to Contribute](#how-to-contribute)\n",
    "    - [Fork the Repository](#fork-the-repository)\n",
    "    - [Create a Branch](#create-a-branch)\n",
    "    - [Make Changes](#make-changes)\n",
    "    - [Commit Changes](#commit-changes)\n",
    "    - [Push to GitHub](#push-to-github)\n",
    "    - [Submit a Pull Request](#submit-a-pull-request)\n",
    "3. [Coding Standards](#coding-standards)\n",
    "4. [Review Process](#review-process)\n",
    "5. [Code of Conduct](#code-of-conduct)\n",
    "\n",
    "## Getting Started\n",
    "\n",
    "To get started with contributing to our project, you should have the following:\n",
    "\n",
    "1. A GitHub account.\n",
    "2. Git installed on your local machine.\n",
    "3. A text editor or IDE of your choice (we recommend VSCode or PyCharm).\n",
    "\n",
    "## How to Contribute\n",
    "\n",
    "### Fork the Repository\n",
    "\n",
    "1. Go to the repository on GitHub.\n",
    "2. Click on the `Fork` button at the top right of the page.\n",
    "3. This will create a copy of the repository in your GitHub account.\n",
    "\n",
    "### Create a Branch\n",
    "\n",
    "1. Clone the forked repository to your local machine:\n",
    "    ```sh\n",
    "    git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git\n",
    "    ```\n",
    "2. Navigate to the repository directory:\n",
    "    ```sh\n",
    "    cd REPOSITORY_NAME\n",
    "    ```\n",
    "3. Create a new branch for your changes:\n",
    "    ```sh\n",
    "    git checkout -b feature/your-feature-name\n",
    "    ```\n",
    "\n",
    "### Make Changes\n",
    "\n",
    "1. Make the necessary changes in your local repository.\n",
    "2. Ensure that your code adheres to the [Coding Standards](#coding-standards).\n",
    "\n",
    "### Commit Changes\n",
    "\n",
    "1. Stage your changes:\n",
    "    ```sh\n",
    "    git add .\n",
    "    ```\n",
    "2. Commit your changes with a descriptive message:\n",
    "    ```sh\n",
    "    git commit -S -m \"Add feature: Description of your feature\"\n",
    "    ```\n",
    "    **Note:** All commits must be signed. You can configure commit signing by following [these instructions](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).\n",
    "\n",
    "### Push to GitHub\n",
    "\n",
    "1. Push your branch to GitHub:\n",
    "    ```sh\n",
    "    git push origin feature/your-feature-name\n",
    "    ```\n",
    "\n",
    "### Submit a Pull Request\n",
    "\n",
    "1. Go to the original repository on GitHub.\n",
    "2. Click on the `Pull Requests` tab.\n",
    "3. Click on the `New Pull Request` button.\n",
    "4. Select your branch from the dropdown menu.\n",
    "5. Submit the pull request with a clear and descriptive title and description.\n",
    "\n",
    "## Coding Standards\n",
    "\n",
    "To ensure consistency and maintainability, please follow these coding standards:\n",
    "\n",
    "1. **PEP 8**: Follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide for Python code.\n",
    "2. **Docstrings**: Use clear and descriptive docstrings for all functions and classes.\n",
    "3. **Type Annotations**: Use type annotations to specify the expected data types of function arguments and return values.\n",
    "4. **Testing**: Write unit tests for your code and ensure all tests pass before submitting a pull request.\n",
    "\n",
    "## Review Process\n",
    "\n",
    "1. Once you submit a pull request, it will be reviewed by one of the maintainers.\n",
    "2. Maintain a positive attitude and be open to feedback. Review comments may request changes to your code.\n",
    "3. Make the necessary changes and update the pull request. Ensure all commits are signed.\n",
    "4. Once the pull request is approved, it will be merged into the main branch.\n",
    "\n",
    "## Code of Conduct\n",
    "\n",
    "We are committed to fostering a welcoming and inclusive community. By participating in this project, you agree to abide by our standards of professional engagement adopted from the [IEEE Code of Conduct](https://www.ieee.org/content/dam/ieee-org/ieee/web/org/about/ieee_code_of_conduct.pdf).\n",
    "\n",
    "Thank you for your contributions! We appreciate your efforts to improve our project.\n"
   ]
  }
 ],
 "metadata": {
  "language_info": {
   "name": "python"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}