Skip to content

docs: update contributing guide to manage python env with hatch shell #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2025

Conversation

wzxxing
Copy link
Contributor

@wzxxing wzxxing commented May 19, 2025

Description

Since the project is already using hatch as the build backend, it would be a more consistent development experience to also manage the python virtual environments using hatch shell.

I added a new env named dev so that contributor can use hatch shell dev to enter this virtual environment. It includes every optional features.

Type of Change

  • Other (please describe): contributing guide

Testing

[How have you tested the change?]

yes

  • hatch fmt --linter
  • hatch fmt --formatter
  • hatch test --all
  • Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli

Checklist

  • I have read the CONTRIBUTING document
  • I have added tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@wzxxing wzxxing marked this pull request as ready for review May 19, 2025 09:16
@wzxxing wzxxing requested a review from a team as a code owner May 19, 2025 09:16
@Unshure Unshure self-assigned this May 19, 2025
@Unshure
Copy link
Member

Unshure commented May 19, 2025

Thanks for the contribution! Looks like the workflows are currently broken, but ive pulled this code locally and run it. Looks like everything passes!

@Unshure Unshure merged commit 77f5fa7 into strands-agents:main May 22, 2025
10 checks passed
@Unshure Unshure mentioned this pull request May 27, 2025
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants