Contributing

Contributing

AgentScript is an open-source project, and we welcome contributions from everyone.

How to Contribute

  1. Join our Discord server: https://discord.gg/hEYMnj62DT (opens in a new tab)
    Talk to us!

  2. Check out GitHub Issues: https://github.com/AgentScript-AI/agentscript/issues (opens in a new tab)
    See what we're working on, post your ideas!

  3. Fork the repository
    Fork the main repository to your own GitHub account

  4. Create a branch
    Create a new branch for your changes

  5. Make your changes
    Implement your changes, add tests, and update documentation

  6. Run tests and linters
    Make sure all tests pass and there are no linting errors

  7. Create a pull request
    Submit a pull request to the main repository

Local Development

To start developing locally:

  1. Clone the repository
    Clone the repository to your local machine

  2. Install dependencies

    yarn

  3. Set up the environment
    Copy .env.example to .env and fill in your API keys

  4. Start the development server

    yarn dev

The yarn dev command uses turbo to watch for changes in the packages and rebuild them automatically.

Release Process

The project uses nx release to manage releases.

Code Style

The project uses Prettier and ESLint for code formatting and linting. Make sure your code adheres to the project's code style.

Roadmap

Check out the README.md (opens in a new tab) for the current roadmap.

Linear