Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (48 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

60 lines (48 loc) · 3.1 KB

Contributing to the Project

Thank you for your interest in contributing to this project! We welcome contributions from everyone. Please follow the guidelines below to ensure a smooth collaboration.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR-USERNAME/mcp-intent-based.git
  3. Install dependencies: npm install
  4. Build the project: npm run build
  5. Run tests: npm test

How to Contribute

  1. Fork the Repository: Click on the "Fork" button at the top right of the repository page to create your own copy of the repository.
  2. Create a Branch: Create a new branch for your feature or bug fix.
  3. Make Your Changes: Implement your changes in the new branch.
  4. Submit a Pull Request: Once your changes are ready, submit a pull request for review.
  5. Review Process: Your pull request will be reviewed by the maintainers. They may suggest changes or improvements.
  6. Merge: Once approved, your changes will be merged into the main branch.

Code Style

  • Follow the existing code style and conventions used in the project.
  • Use meaningful commit messages that describe the changes made.
  • Ensure that your code passes all tests before submitting a pull request.

Testing

  • Run the existing tests to ensure that your changes do not break any functionality.
  • If you add new features, please include tests for them as well.

Documentation

  • Update the documentation to reflect any changes made to the codebase.
  • Ensure that the README file is up to date with the latest information about the project.

Issues

  • If you find any bugs or issues, please report them by creating a new issue in the repository.
  • When reporting an issue, provide as much detail as possible, including steps to reproduce the issue and any relevant error messages.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please be respectful and considerate in your interactions with others.

Contact

If you have any questions or need assistance, feel free to reach out to the maintainers of the project. You can find their contact information in the repository.

Project Structure

  • src/: Contains the source code for the project.
  • tests/: Contains the test cases for the project.

Documentation is managed by Documentation Team and kept in Agentico website.

Project Setup

Info for Collaborators

  • Added bunup configuration for building the project.
  • Implemented createContext function for managing context in tools.
  • Established a registry for tools with functions to create and retrieve tools.
  • Implemented runtime functions for executing tools and handling transport connections.
  • Created server functionality to read configuration from YAML/JSON and manage tools.
  • Added a sample tool for summarizing text.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Terms of Service

By using this software, you agree to abide by the Terms of Service, which include restrictions on reverse engineering and other prohibited activities.