Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

50 lines (39 loc) · 1.34 KB

Contributing to COMANDI

We're excited that you're interested in contributing to COMANDI! This document outlines the process for contributing to this project.

Getting Started

  1. Fork this repo
  2. Clone your fork locally
  3. Install requirements: 
    pip install -r requirements.txt

Making Changes

  1. Create a new branch for your feature or bugfix:

    git checkout -b feature/your-feature-name

    or

    git checkout -b fix/your-bugfix-name

  2. Make your changes in the new branch

  3. Commit your changes:

    git commit -m "Description of your changes"

  4. Push your changes to your fork:

    git push origin feature/your-feature-name

Opening a Pull Request

  1. Go to the original COMANDI repository on GitHub
  2. Click on "Pull requests" and then the "New pull request" button
  3. Click "compare across forks" and select your fork and branch
  4. Click "Create pull request"
  5. Fill out the pull request template with a clear title and description of your changes
  6. Submit the pull request

After Submitting

  • Respond to any feedback or questions from the maintainers
  • Make any requested changes to your branch and push them to your fork
  • Once approved, your changes will be merged into the main project

Thank you for contributing to COMANDI!