Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
163 lines (112 loc) · 5.4 KB

CONTRIBUTING.md

File metadata and controls

163 lines (112 loc) · 5.4 KB

Contributing to Bedrock AgentCore SDK Python

👋 Welcome! We're glad you're interested in the Bedrock AgentCore SDK Python.

🔒 Code Contribution Policy

This repository is maintained exclusively by the AWS Bedrock AgentCore team and is not currently accepting external pull requests.

While we appreciate your interest in contributing code, we maintain this policy to:

  • Ensure code quality and security standards
  • Maintain consistency with internal AWS development practices
  • Align with our product roadmap and architecture decisions
  • Comply with AWS security and compliance requirements

Development Setup (For AWS Team Members)

Initial Setup

# Clone the repository
git clone https://github.com/aws/bedrock-agentcore-sdk-python.git
cd bedrock-agentcore-sdk-python

# Create virtual environment and install dependencies
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv sync

# Install pre-commit hooks (one-time)
pre-commit install

That's it! You're ready to develop.

Daily Development Workflow

Pre-commit hooks will now run automatically:

# Make your changes
vim src/bedrock_agentcore/myfile.py

# Commit (hooks run automatically)
git commit -m "feat: add new feature"
# ↑ Formatting and linting run here

# Push (tests run automatically)
git push origin my-branch
# ↑ Security scanning and tests run here

What the Hooks Check

On every commit (~10-20 seconds):

  • ✅ Code formatting (auto-fixes with ruff)
  • ✅ Import sorting (auto-fixes)
  • ✅ Linting (with ruff)
  • ✅ File hygiene (trailing whitespace, etc.)

Before every push (~2-5 minutes):

  • ✅ Security scanning (bandit)
  • ✅ Full test suite with coverage

Skipping Hooks (WIP Commits)

For work-in-progress commits, you can skip checks:

git commit --no-verify -m "wip: incomplete work"

Please run all checks before opening a PR!

Running Checks Manually

# Run all pre-commit checks
pre-commit run --all-files

# Run only pre-commit stage (fast)
pre-commit run --hook-stage pre-commit --all-files

# Run only pre-push stage (includes tests)
pre-commit run --hook-stage pre-push --all-files

# Run tests manually
uv run pytest tests/ --cov=src

How You Can Help

Although we don't accept code contributions, your feedback is invaluable! Here's how you can help improve the SDK:

Report Bugs

Found something that doesn't work as expected? Please open an issue with:

  • A clear description of the problem
  • Steps to reproduce the issue
  • Expected vs actual behavior
  • Environment details (OS, Python version, SDK version)
  • Relevant code snippets and error messages

Request Features

Have an idea for a new feature? Please open a feature request with:

  • Description of the problem you're trying to solve
  • Proposed solution or feature
  • Use cases and examples
  • Any alternative solutions you've considered

Improve Documentation

Spot an error or unclear explanation in our docs? Please open a documentation issue with:

  • Link to the documentation page
  • Description of the issue or improvement
  • Suggested changes (if applicable)

Share Examples

While we can't accept code PRs, we'd love to hear about your use cases:

  • Open a "Show and Tell" discussion in our Discussions forum
  • Share your experience and learnings
  • Help other users with questions

Issue Guidelines

When creating an issue:

  1. Search first: Check if a similar issue already exists
  2. Use templates: Select the appropriate issue template
  3. Be specific: Provide as much detail as possible
  4. Stay on topic: Keep discussions focused on the issue
  5. Be respectful: Follow our Code of Conduct

Security Issues

For security vulnerabilities, please DO NOT open a public issue. Instead:

See our Security Policy for more details.

Questions and Discussions

Code of Conduct

This project adheres to the Amazon Open Source Code of Conduct. By participating, you're expected to uphold this code.

Governance

This project is governed by the AWS Bedrock AgentCore team. Decisions about the project's direction, features, and releases are made internally by AWS.

License

By engaging with this project, you agree that your contributions (issues, discussions, etc.) are submitted under the Apache 2.0 License.

🙏 Thank You

Even though we can't accept code contributions at this time, your feedback, bug reports, and feature requests help us make the Bedrock AgentCore SDK better for everyone. We truly appreciate your involvement and support!

Note: This policy may change in the future. If we open the repository to external contributions, we'll update this document and announce the change.