Skip to content

Latest commit

 

History

History
88 lines (64 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

88 lines (64 loc) · 2.64 KB
Raw

Contributing to Gemini Chat

Welcome to Gemini Chat's community! We appreciate contributions. Follow these guidelines to contribute.

Getting Started

Prerequisites

  • Python (version 3.9 or later)
  • Flask (version 3.0 or later)
  • Google cloud CLI
  • Other required libraries (install using pip install -r requirements.txt)
  • Gemini API key (obtain from the Maker Suite Google )
  • Google Cloud CLI

Installation STEPS:

1.Clone the repository:

git clone https://github.com/lokendarjangid/gemini-chat.git

2.Move to Directory

cd gemini-chat-bot

3.Create a virtual environment (optional but recommended):

python -m venv venv
source venv/bin/activate

On Windows, use venv\Scripts\activate

4.Install dependencies:

pip install -r requirements.txt

5.Configuring the Gemini API Key

  1. Copy your Gemini API key from the Maker Suite Google.
  2. Create a .env file in the project directory (if not already present).
  3. Paste the API key into the .env file as follows: 
    GEMINI_API_KEY="your_api_key_here'

Contributing Guidelines

Suggesting Features or Reporting Bugs

  • Use the GitHub issue tracker for feature requests or bug reports.
  • Provide clear and detailed descriptions, including:
    • Steps to reproduce the issue (if applicable)
    • Expected behavior
    • Actual behavior

Making Changes

  1. Fork the repository on GitHub.
  2. Create a new branch for your changes.
  3. Make changes and commit them with clear messages.
  4. Push changes to your fork.
  5. Open a pull request from your fork to the main repository.

Documentation

  • Update existing documentation to reflect changes.
  • Add new documentation for new features.

Community

  • Use the GitHub issue tracker for discussions and questions.
  • Participate in code reviews to improve code quality.

Additional Information

  • Contribution Review Process: We'll review pull requests and provide feedback promptly.
  • Good First Issues: Issues labeled as "good first issue" in the tracker are suitable for new contributors.
  • Relevant Resources:

Welcome to Gemini Chat's community! We appreciate contributions. Follow these guidelines to contribute.

Getting Started

Thank you for your interest in contributing to Gemini Chat!