Contributing
This is AG2 Classic — the classic AG2 framework built around ConversableAgent, published to PyPI as autogen. It is in maintenance mode.
Building something new? Contribute to AG2 instead
New features, enhancements, and new integrations belong in the actively developed AG2 project, not here:
- Repository: github.com/ag2ai/ag2
- Package:
ag2on PyPI - Documentation: docs.ag2.ai
What maintenance mode means#
AG2 Classic receives security and critical bug fixes only — there are no new features. We keep the existing framework installable, safe, and working on supported Python versions, and we correct its documentation. That's it.
What we accept#
- Security fixes — patches for confirmed vulnerabilities. Report these privately first (see File a Bug Report and the repository's
SECURITY.md). - Critical bug fixes — corrections to broken behaviour in existing functionality.
- Maintenance — dependency and compatibility updates, build/packaging fixes, and CI upkeep needed to keep the package usable.
- Documentation corrections — fixing inaccurate, broken, or outdated documentation for existing behaviour.
What we do not accept#
- New features or enhancements of any kind.
- New agents, tools, models, or integrations.
- API changes or refactors not required to fix a security issue or critical bug.
- Behavioural changes beyond what is needed to restore correct, documented behaviour.
Feature and enhancement PRs will be closed
Pull requests that add features or enhancements will be closed with a pointer to ag2. Please open your idea there instead.
How to contribute a fix#
- Open an issue first for anything beyond a trivial fix, so a maintainer can confirm it's in scope for maintenance mode before you invest time. For security vulnerabilities, use the private reporting process in the repository's
SECURITY.md— do not open a public issue. - Set up your environment — see Setting up your environment.
- Keep the change focused — a maintenance PR should fix one thing and touch the minimum surface area needed.
- Add or update tests covering the fix where relevant — see Tests.
- Run the checks — install and run pre-commit hooks and make sure the full test suite passes.
- Open your pull request against github.com/ag2ai/ag2classic and fill in the PR template, indicating the type of change.
License headers#
Include the following header at the top of each new source file you create:
# Copyright (c) 2023 - 2026, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
#
# SPDX-License-Identifier: Apache-2.0
For files that contain or are derived from the original MIT-licensed code from microsoft/autogen, use this extended header:
# Copyright (c) 2023 - 2026, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
#
# SPDX-License-Identifier: Apache-2.0
#
# Portions derived from https://github.com/microsoft/autogen are under the MIT License.
# SPDX-License-Identifier: MIT
Please update the year range as appropriate. If you're unsure which header to use, ask in your pull request.
Questions#
For questions, discussion, or help getting started with the actively developed version, join the AG2 community on Discord.