Skip to content

Contribution.md

Latest commit

 

History

History
72 lines (50 loc) · 2.72 KB

Contribution.md

File metadata and controls

72 lines (50 loc) · 2.72 KB

Contributing to MuetGPT

Thank you for your interest in contributing to MuetGPT! We appreciate your help in making our project better.

Before you start contributing, please take a moment to read and understand our guidelines. This will help ensure a smooth collaboration process.

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Code Style
  4. Submitting a Pull Request
  5. Reporting Issues
  6. Community and Communication

Getting Started

  • Make sure you have Git installed on your machine.
  • Fork the repository on GitHub.
  • Clone your forked repository to your local machine: 
    git clone https://github.com/your-username/muetgpt.git

How to Contribute

Contributions to MuetGPT can come in various forms:

  • Reporting issues (bugs, suggestions, enhancements).
  • Providing feedback and suggestions on existing issues.
  • Writing code to fix bugs or add new features.
  • Improving documentation.
  • Providing us with more data related to MUET.
  • Helping us in making a website for this project.

Code Style

  • Follow the existing code style and conventions used in the project.
  • Maintain consistency with the coding style used in the project.

Submitting a Pull Request

  1. Create a new branch from the main branch:

    git checkout -b your-feature-branch

  2. Make your changes, following the code style and conventions.

  3. Commit your changes with a clear and descriptive commit message:

    git commit -m "Add feature XYZ"

  4. Push your branch to your GitHub repository:

    git push origin your-feature-branch

  5. Open a pull request on GitHub, providing a clear description of your changes and linking to any relevant issues.

  6. Your pull request will be reviewed by project maintainers. Be prepared to address any feedback or make necessary changes.

Reporting Issues

  • Use the GitHub issue tracker to report bugs, suggest enhancements, or ask questions.
  • Before creating a new issue, please search for existing issues to avoid duplicates.
  • Provide detailed information about the issue you're facing, including steps to reproduce it.

Community and Communication