Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (33 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

40 lines (33 loc) · 1.77 KB
Raw

Contributing to AI-based Translator

Thank you for your interest in contributing to the AI-based Translator project! We welcome all contributions, including bug fixes, feature suggestions, documentation updates, and translations.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine: 
    git clone https://github.com/YOUR_USERNAME/Chat-with-KB.git
  3. Load the extension in your browser:
    • For Edge: Go to edge://extensions/, enable Developer mode, click Load unpacked, and select the project directory.
    • For Chrome: Go to chrome://extensions/, enable Developer mode, click Load unpacked, and select the project directory.

How to Contribute

Reporting Bugs or Requesting Features

  • Please check the Issue tracker first to see if it has already been reported.
  • If not, open a new Issue. Describe the bug or feature request clearly, including steps to reproduce or implementation ideas.

Submitting Pull Requests

  1. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  2. Make your modifications, adhering to the project's existing code style.
  3. Test your changes locally to ensure the extension functions correctly and has no errors in the console.
  4. Commit your changes: 
    git commit -m "Add some awesome feature"
  5. Push to your fork: 
    git push origin feature/your-feature-name
  6. Open a Pull Request against the main branch of this repository.

Community Code of Conduct

Please be respectful and polite in all interactions within this project's issues and pull requests. We want to keep this community welcoming and helpful to everyone!