generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 195
feat(designs): Create designs folder #487
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| # Design Documents | ||
|
|
||
| This folder contains design documents for significant features and changes to Strands Agents. These documents capture the context, decision, and consequences of architectural choices. | ||
|
|
||
| For lightweight architecture decision records, see [DECISIONS.md](../team/DECISIONS.md). | ||
|
|
||
| ## What is a design document? | ||
|
|
||
| A design document proposes a significant change or new feature. It describes the problem, proposed solution, and tradeoffs. Once approved and merged, it becomes an accepted design and part of the project's decision history. | ||
|
|
||
| ## When to write a design document | ||
|
|
||
| Write a design document for: | ||
|
|
||
| - New major features affecting multiple parts of the SDK | ||
| - Breaking changes to existing APIs | ||
| - Architectural changes requiring design discussion | ||
| - Large contributions (> 1 week of work) | ||
| - Features that introduce new concepts | ||
|
|
||
| Skip the design process for bug fixes, small improvements, documentation updates, and new extensions in your own repository. | ||
|
|
||
| ## How to submit a feature proposal | ||
|
|
||
| 1. **Check the [roadmap](https://github.com/orgs/strands-agents/projects/8/views/1)** — See if your idea aligns with our direction | ||
| 2. **Fork the [docs repository](https://github.com/strands-agents/docs)** | ||
| 3. **Create your design** — Add a new file: `designs/NNNN-feature-name.md` using the template below | ||
| 4. **Submit a pull request** — We'll review and discuss | ||
| 5. **Iterate based on feedback** — Address comments and questions | ||
| 6. **Get approval** — Once approved and merged, implement the feature | ||
| 7. **Reference the design** — Link to it in your implementation PR | ||
|
|
||
| ## Design document template | ||
|
|
||
| ```markdown | ||
| # [Feature Name] | ||
|
|
||
| **Status**: Proposed | Accepted | Deprecated | Superseded | ||
|
|
||
| **Date**: YYYY-MM-DD | ||
|
|
||
| **Issue**: Issue Link | ||
|
|
||
| ## Context | ||
|
|
||
| What is the issue that we're seeing that is motivating this decision or change? | ||
|
|
||
| - What task are you trying to accomplish? | ||
| - What makes it difficult or impossible today? | ||
| - Who experiences this problem? | ||
|
|
||
| ## Decision | ||
|
|
||
| What is the change that we're proposing and/or doing? | ||
|
|
||
| - Changes to the API (with code examples) | ||
| - How it integrates with existing features | ||
| - Expected behavior and usage patterns | ||
|
|
||
| ## Developer Experience | ||
|
|
||
| Show what the developer experience looks like: | ||
|
|
||
| - Code examples showing typical usage | ||
| - Configuration or setup required | ||
| - Error messages and edge cases | ||
|
|
||
| ## Alternatives Considered | ||
|
|
||
| What other approaches did you consider? Why did you choose this one? | ||
|
|
||
| ## Consequences | ||
|
|
||
| What becomes easier or more difficult to do because of this change? | ||
|
|
||
| ## Willingness to Implement | ||
|
|
||
| Are you willing to implement this if approved? | ||
|
|
||
| Yes / No / Maybe with guidance | ||
| ``` | ||
|
|
||
| ## Accepted Designs | ||
|
|
||
| *No designs have been accepted yet.* |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.