Skip to content

Latest commit

 

History

History
74 lines (58 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

74 lines (58 loc) · 2.58 KB

Contributing to Moe-KAN

Thank you for your interest in contributing to Moe-KAN! We welcome contributions from the community and are excited to collaborate with you. Please follow the guidelines below to contribute effectively.

Table of Contents

Getting Started

  1. Fork the repository to your own GitHub account.
  2. Clone the repository to your local machine: 
    git clone https://github.com/your-username/Moe-KAN.git
  3. Create a new branch for your feature or bug fix: 
    git checkout -b feature-or-bugfix-name
  4. Install the required dependencies: 
    pip install -r requirements.txt

How to Contribute

Reporting Bugs

If you find a bug in the project, please open an issue on GitHub with the following information:

  • A clear and descriptive title.
  • A detailed description of the problem, including steps to reproduce.
  • Any relevant logs, screenshots, or other information.

Suggesting Enhancements

If you have an idea for an enhancement or new feature, please open an issue on GitHub with the following information:

  • A clear and descriptive title.
  • A detailed description of the proposed enhancement or feature.
  • Any relevant examples, mockups, or diagrams.

Submitting Pull Requests

  1. Ensure your branch is up to date with the latest changes from the main branch: 
    git pull origin main
  2. Make your changes, following the code style guidelines outlined below.
  3. Commit your changes with a clear and descriptive commit message: 
    git commit -m "Description of the changes"
  4. Push your changes to your forked repository: 
    git push origin feature-or-bugfix-name
  5. Open a pull request on GitHub, linking to the relevant issue if applicable.

Code Style

  • Follow the PEP 8 style guide for Python code.
  • Use meaningful variable and function names.
  • Write clear and concise docstrings for all functions and classes.
  • Include type annotations where applicable.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. We are committed to providing a welcoming and inclusive environment for all contributors.

Thank you for contributing to Moe-KAN! Your efforts help make this project better for everyone.