Skip to content

Latest commit

 

History

History
161 lines (109 loc) · 7.29 KB

CONTRIBUTING.md

File metadata and controls

161 lines (109 loc) · 7.29 KB
Raw

Contributing

Bee Agent Framework is an open-source project committed to bringing LLM agents to people of all backgrounds. This page describes how you can join the Bee community in this goal.

Before you start

If you are new to Bee contributing, we recommend you do the following before diving into the code:

Style and lint

Bee uses the following tools to meet code quality standards and ensure a unified code style across the codebase.

Issues and pull requests

We use GitHub pull requests to accept contributions.

While not required, opening a new issue about the bug you're fixing or the feature you're working on before you open a pull request is important in starting a discussion with the community about your work. The issue gives us a place to talk about the idea and how we can work together to implement it in the code. It also lets the community know what you're working on, and if you need help, you can reference the issue when discussing it with other community and team members. If you've written some code but need help finishing it, want to get initial feedback on it before finishing it, or want to share it and discuss it prior to completing the implementation, you can open a Draft pull request and prepend the title with the [WIP] tag (for Work In Progress). This will indicate to reviewers that the code in the PR isn't in its final state and will change. It also means we will only merge the commit once it is finished. You or a reviewer can remove the [WIP] tag when the code is ready to be thoroughly reviewed for merging.

Choose an issue to work on

Bee uses the following labels to help non-maintainers find issues best suited to their interests and experience level:

  • good first issue - these issues are typically the simplest available to work on, ideal for newcomers. They should already be fully scoped, with a straightforward approach outlined in the descriptions.
  • help wanted - these issues are generally more complex than good first issues. They typically cover work that core maintainers don't currently have the capacity to implement and may require more investigation/discussion. These are great options for experienced contributors looking for something more challenging.

Set up a development environment

To start contributing to the Bee Agent framework, follow these steps to set up your development environment:

  1. Install Node Version Manager (NVM): We use .nvmrc to specify the required Node.js version. Install nvm by following the official installation instructions.

  2. Install the Correct Node.js Version: Use nvm to install and use the Node.js version specified in the .nvmrc file:

nvm install
nvm use
  1. Install Yarn via Corepack: This project uses Yarn as the package manager. Ensure you have Corepack enabled and install Yarn:
corepack enable
  1. Install Dependencies: Install all project dependencies by running:
yarn install --immutable
yarn prepare
  1. Setup environmental variables: To run E2E Tests, you should set the following variables in your .env file in the repository’s root.
# At least one provider API key or an OLLAMA_HOST must be defined!
GENAI_API_KEY=""
OPENAI_API_KEY=""
GROQ_API_KEY=""
WATSONX_API_KEY=""
WATSONX_PROJECT_ID=""
OLLAMA_HOST=""
OPENAI_API_VERSION=""
AZURE_DEPLOYMENT_NAME=""
AZURE_OPENAI_API_KEY=""
AZURE_OPENAI_ENDPOINT=""
GOOGLE_APPLICATION_CREDENTIALS=""
GCP_VERTEXAI_PROJECT=""
GCP_VERTEXAI_LOCATION=""

WATSONX_SPACE_ID="" # optional
WATSONX_DEPLOYMENT_ID=""  # optional
  1. Follow Conventional Commit Messages: We use Conventional Commits to structure our commit messages. This helps maintain a clean and manageable commit history. Please use the following format:
<type>(<scope>): <subject>
  • Type: feat, fix, chore, docs, style, refactor, perf, test, etc.
  • Scope: The area of the codebase your changes affect (optional). The allowed values are: adapters, agents, llms, tools, cache, emitter, internals, logger, memory, serializer, infra, deps, instrumentation. The latest values are listed in package.json
  • Subject: A short description of the changes (required).

Example:

feat(llms): add streaming support for watsonx adapter

Ref: #15
  1. Run Linters/Formatters: Ensure your changes meet code quality standards. Run the following commands:
yarn lint # or yarn lint:fix
yarn format # or yarn format:fix
  1. Run Tests: Ensure your changes pass all tests (unit, integration, E2E). Run the following commands:
yarn test:unit
yarn test:e2e

By following these steps, you'll be all set to contribute to our project! If you encounter any issues during the setup process, please feel free to open an issue.

Legal

The following sections detail important legal information that should be viewed prior to contribution.

License and Copyright

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0

If you would like to see the detailed LICENSE click here.

Developer Certificate of Origin (DCO)

We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution. We use the same approach - the Developer's Certificate of Origin 1.1 (DCO) - that the Linux® Kernel community uses to manage code contributions.

We ask that when submitting a patch for review, the developer must include a sign-off statement in the commit message. If you set your user.name and user.email in your git config file, you can sign your commit automatically by using the following command:

git commit -s

The following example includes a Signed-off-by: line, which indicates that the submitter has accepted the DCO:

Signed-off-by: John Doe <john.doe@example.com>

We automatically verify that all commit messages contain a Signed-off-by: line with your email address.

Useful tools for doing DCO signoffs

There are a number of tools that make it easier for developers to manage DCO signoffs.