Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 2.72 KB

CONTRIBUTION.md

File metadata and controls

64 lines (48 loc) · 2.72 KB
Raw

Contribution Guide

Thank you for considering contributing to Cadmi_AI! This guide will help you get started and ensure a smooth contribution experience. We appreciate all contributions, big or small.

Table of Contents

  1. Getting Started
  2. Issues and Feature Requests
  3. Development Workflow
  4. Code Guidelines
  5. Submitting a Pull Request
  6. Review Process

1. Getting Started

  1. Fork the Repository: Start by forking the Cadmi_AI repository to your GitHub account.
  2. Clone the Repository: Clone your forked repository locally to start making changes. 
    git clone https://github.com/YOUR-USERNAME/Cadmi_AI.git
cd Cadmi_AI
  3. Set Up the Environment: Ensure you have all dependencies installed by following the setup instructions in the README.md.

2. Issues and Feature Requests

  • Looking for First Issues? Check out issues labeled good first issue to find beginner-friendly tasks.
  • Feature Requests: If you have a feature suggestion, open a new issue and describe your idea in detail.
  • Bug Reports: If you encounter a bug, please report it. Provide a clear, detailed description and, if possible, steps to reproduce the issue.

3. Development Workflow

  1. Create a Branch: Always create a new branch for your work. 
    git checkout -b feature-or-bug-name
  2. Make Changes: Write and test your code locally.
  3. Commit Changes: Follow conventional commit guidelines and provide a descriptive commit message. 
    git commit -m "feat: add new feature to improve AI accuracy"
  4. Push Changes: Push your branch to your forked repository. 
    git push origin feature-or-bug-name

4. Code Guidelines

  • Formatting: Ensure your code follows the style guide (e.g., Prettier, ESLint).
  • Comments: Add comments to explain complex code and ensure readability.
  • Testing: Write tests for your code where applicable to help maintain project stability.

5. Submitting a Pull Request

  1. Open a Pull Request (PR): Once your changes are ready, open a PR from your branch to the main branch.
  2. PR Details: Provide a clear description of your changes, link any relevant issues, and explain any decisions made during development.

6. Review Process

  • Your PR will be reviewed by a project maintainer. Please be patient and responsive to feedback.
  • Address any requested changes and push updates to your branch.
  • Once approved, your PR will be merged into the main repository.

Thank you for contributing to Cadmi_AI! We look forward to collaborating with you.