Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (68 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

93 lines (68 loc) · 2.99 KB
Raw

Contributing to Agentuity

Thank you for your interest in contributing to Agentuity! We're excited to have you join our community. This document provides guidelines and instructions for contributing to this project.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. We expect all contributors to be respectful and professional in all interactions.

How to Contribute

There are many ways you can contribute to this project:

  1. Reporting Bugs

    • Use the GitHub Issues page to report bugs
    • Clearly describe the issue, including steps to reproduce
    • Include any relevant code snippets or error messages
    • Tag the issue with appropriate labels

  2. Suggesting Enhancements

    • Use GitHub Issues to suggest new features or improvements
    • Provide a clear description of the proposed enhancement
    • Explain why this enhancement would be useful
    • Include any relevant examples or mockups

  3. Code Contributions

    • Fork the repository
    • Create a new branch for your feature (git checkout -b feature/amazing-feature)
    • Make your changes
    • Write or update tests as needed
    • Ensure your code follows our style guidelines
    • Submit a pull request

Pull Request Process

  1. Before Submitting a PR

    • Ensure your code follows our coding standards
    • Update documentation as needed
    • Add tests for new functionality
    • Run the test suite locally

  2. Submitting Your PR

    • Create a clear, descriptive PR title
    • Fill out the PR template completely
    • Reference any related issues
    • Include screenshots or code examples if applicable

  3. After Submitting

    • Respond to any feedback or review comments
    • Make requested changes if necessary
    • Be patient during the review process

Development Setup

  1. Fork and clone the repository
  2. Install dependencies according to the project's README
  3. Create a new branch for your work
  4. Make your changes
  5. Test your changes thoroughly

Coding Standards

  • Follow the existing code style
  • Write clear, descriptive commit messages
  • Comment your code when necessary
  • Keep functions and methods focused and concise
  • Use meaningful variable and function names

Testing

  • Write tests for new functionality
  • Ensure all tests pass before submitting
  • Include both unit and integration tests where appropriate
  • Document test cases clearly

Documentation

  • Update documentation for any changed functionality
  • Write clear and concise documentation
  • Include code examples where helpful
  • Keep README and other docs up to date

Questions or Need Help?

  • Join our Discord community
  • Check existing issues and discussions
  • Create a new issue for questions
  • Reach out to maintainers if needed

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project (Apache-2.0).

Thank you for contributing to Agentuity! Your efforts help make this project better for everyone.