Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

81 lines (60 loc) · 3.02 KB

Contributing to Dr.QP

First of all, thank you for considering contributing to Dr.QP! Open source thrives on community involvement, and your help is greatly appreciated.

Table of Contents

Getting Started

  1. Fork the Repository: Click on the "Fork" button at the top-right of the repository page to create your own copy.
  2. Clone Your Fork: 
    git clone https://github.com/your-username/Dr.QP.git
cd Dr.QP
  3. Set Upstream: Link your local repository to the original repository to keep it updated. 
    git remote add upstream https://github.com/Dr-QP/Dr.QP.git
  4. Install Dependencies: Follow the instructions in the README.md to install dependencies and set up the development environment.

How to Contribute

Reporting Issues

If you find a bug or have a question, please create an issue:

  1. Check the issue tracker to see if it has already been reported.
  2. If not, click "New Issue" and provide as much detail as possible:
    • A clear and descriptive title.
    • Steps to reproduce the issue.
    • Expected behavior and what actually happens.
    • Relevant logs, screenshots, or code examples.

Suggesting Features

We welcome feature suggestions! To propose a new feature:

  1. Check the issue tracker to ensure your idea hasn't been suggested.
  2. Open a new issue with the "Feature Request" template.
  3. Describe the problem your feature will solve and how you envision it working.

Submitting Code Changes

  1. Create a Branch: 
    git checkout -b feature/your-feature-name
  2. Make Changes: Follow the coding style and guidelines of the project. Ensure that your changes include necessary documentation and tests.
  3. Commit Changes: Write clear and concise commit messages. 
    git commit -m "Add detailed description of your change"
  4. Push to Your Fork: 
    git push origin feature/your-feature-name
  5. Open a Pull Request: Go to the original repository and click "New Pull Request."
    • Ensure your pull request includes a clear description of the changes and references any related issues.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. Please review it to ensure a positive experience for everyone involved.

License

By contributing to Dr.QP, you agree that your contributions will be licensed under the MIT License.

Thank you for your interest in contributing to Dr.QP! Together, we can build something amazing.