Skip to content

Latest commit

 

History

History
80 lines (58 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

80 lines (58 loc) · 1.69 KB

Contributing to Ajent

Thanks for your interest in contributing to Ajent! This document provides a simple set of guidelines for contributing to the project.

Quick Start

  1. Fork the repository
  2. Clone your fork:
git clone https://github.com/your-username/ajent.git
  1. Create a new branch:
git checkout -b feature/your-feature-name

Development Setup

  1. Install dependencies:
npm install
  1. Run tests:
npm test

Making Changes

  1. Write your code
  2. Add tests if applicable
  3. Ensure all tests pass
  4. Update documentation if needed

Commit Guidelines

Use clear and meaningful commit messages. For example:

  • feat: add new customer service agent
  • fix: handle undefined tool response
  • docs: update README with new examples
  • test: add tests for triage agent

Submitting Pull Requests

  1. Push your changes to your fork
  2. Create a Pull Request from your fork to the main repository
  3. Describe your changes in the PR description
  4. Link any related issues

Code Style

  • Use ES6+ features
  • Follow existing code formatting
  • Use meaningful variable and function names
  • Add comments for complex logic

Reporting Issues

When reporting issues, please include:

  • Description of the issue
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Environment details (Node.js version, etc.)

Questions?

If you have questions, feel free to open an issue with the "question" label.

Code of Conduct

  • Be respectful and inclusive
  • Help others learn and grow
  • Focus on constructive feedback
  • Follow project maintainers' guidance

License

By contributing, you agree that your contributions will be licensed under the project's ISC License.