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

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (43 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

67 lines (43 loc) · 2.62 KB

Contributing to AIBTC Agent Tools (TypeScript)

We're thrilled that you're interested in contributing to the AIBTC Agent Tools project! This document outlines the process for contributing and provides some guidelines to ensure a smooth collaboration.

How to Contribute

  1. Fork the Repository: Start by forking the agent-tools-ts repository to your GitHub account.

  2. Clone the Fork: Clone your fork to your local machine:

    git clone https://github.com/your-username/agent-tools-ts.git
cd agent-tools-ts

  3. Create a Branch: Create a new branch for your feature or bug fix:

    git checkout -b feature/your-feature-name

  4. Make Changes: Make your changes to the codebase. Be sure to follow our coding standards (see below).

  5. Test Your Changes: Ensure that your changes don't break any existing functionality. Add new tests if necessary.

  6. Commit Your Changes: Commit your changes with a clear and descriptive commit message:

    git commit -m "Add a brief description of your changes"

  7. Push to Your Fork: Push your changes to your GitHub fork:

    git push origin feature/your-feature-name

  8. Create a Pull Request: Go to the original agent-tools-ts repository on GitHub and create a new pull request from your feature branch.

Coding Standards

  • Follow the existing code style in the project.
  • Use TypeScript for all new scripts.
  • Write clear, commented code that others can easily understand and maintain.
  • Include appropriate error handling and logging.
  • Add a test file that covers the script functionality.
  • Update the README.md if you're adding new features or changing existing functionality.

Reporting Issues

If you find a bug or have a suggestion for improvement:

  1. Check if the issue already exists in the GitHub Issues.
  2. If not, create a new issue, providing as much detail as possible, including steps to reproduce for bugs.

Pull Request Process

  1. Ensure your code adheres to the coding standards outlined above.
  2. Update the README.md with details of changes to the interface, if applicable.
  3. Your pull request will be reviewed by the maintainers. Be open to feedback and be prepared to make changes if requested.
  4. Once approved, your pull request will be merged into the main branch.

Questions?

If you have any questions about contributing, feel free to ask in the AIBTC Discord or reach out to us on X @aibtcdev.

Thank you for contributing to AIBTC Agent Tools!