Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (48 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

63 lines (48 loc) · 2.23 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to this project! Please follow these guidelines to help us maintain a high-quality codebase and collaborative environment.

How to Contribute

  1. Fork the Repository

    • Click the "Fork" button at the top right of the repository page to create your own copy.

  2. Clone Your Fork

    • Clone your forked repository to your local machine: 
      git clone https://github.com/your-username/agentic-ai.git
cd agentic-ai

  3. Create a Branch

    • Create a new branch for your feature or bugfix: 
      git checkout -b feature/your-feature-name

  4. Make Changes

    • Make your changes, following the code style and best practices used in the project.
    • Add or update tests as needed.

  5. Test Your Changes

    • Run tests locally to ensure your changes are working properly.
    • If applicable, update documentation.

  6. Document How to Run the Code

    • If your changes require new steps to run the code, update the relevant documentation (e.g., README.md or a new file) with clear instructions on setup, dependencies, and execution.

  7. Commit and Push

    • Commit your changes with a clear and descriptive message: 
      git add .
git commit -m "Add feature: your feature description"
git push origin feature/your-feature-name

  8. Open a Pull Request

    • Go to the original repository and open a Pull Request from your branch.
    • Provide a clear description of your changes and reference any related issues.

  9. Review Process

    • Your Pull Request will be reviewed by maintainers.
    • Please respond to feedback and make any requested changes.

Code Style

  • Follow the existing code style and conventions.
  • Write clear, concise commit messages.
  • Include comments where necessary.

Reporting Issues

  • Use the Issues tab to report bugs or request features.
  • Provide as much detail as possible, including steps to reproduce and screenshots if applicable.

Community Standards

Thank you for helping make this project better!