chore(agents): Add AGENTS.md
#3426
Merged
Conversation
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
…structure - Updated guidelines to ensure test group and test names read as coherent sentences. - Introduced a structured approach for naming by depth, emphasizing the use of subjects, contexts, variants, and behaviors. - Added examples and anti-patterns to illustrate best practices in test organization and naming.
- Added comprehensive guidelines for identifiers, ordering, formatting, comments, and documentation to improve code consistency and readability. - Included best practices for naming conventions, code structure, and documentation styles to align with the Effective Dart guide. - Emphasized the importance of adhering to these guidelines for new and modified tests.
- Streamlined project structure section by removing table format for a more concise list format. - Updated environment section to include specific Flutter and Dart versions. - Enhanced testing guidelines with clearer commands and descriptions for Dart and Flutter packages. - Added new guidelines for modern Dart language features to promote clarity and reduce boilerplate in code.
denrase
requested changes
Jan 5, 2026
AGENTS.md
Outdated
|
|
||
| ### Test File Organization | ||
|
|
||
| When a test file grows large, consider splitting it into sub-files by context: |
Collaborator
There was a problem hiding this comment.
Probably more of a code-smell if single classes have so many responsibilities what we need to split up test files just to keep it understandable, no?
Contributor
Author
There was a problem hiding this comment.
usually yea, but we do have examples of those like Hub, Client where the test file itself is 1k LoC
we can probably remove this, makes more sense to judge individually
Contributor
Author
|
putting this into draft, I saw some blog posts about writing better |
- Updated AGENTS.md to clarify the structure and purpose of the Sentry Dart/Flutter SDK. - Introduced new documentation files for code guidelines and test conventions, emphasizing best practices for Dart/Flutter development. - Added detailed sections on naming conventions, test structure, and the use of modern Dart features to improve code clarity and maintainability. - Ensured that all new and modified code adheres to these updated guidelines for consistency across the project.
Contributor
Author
|
@denrase updated it |
- Renamed section from "Doc Comments" to "Documentation Comments" for clarity. - Added recommendations for when to write comments, emphasizing the importance of self-documenting code. - Included specific guidelines on documenting public APIs and non-obvious reasoning, while advising against commenting on obvious behavior and providing excessive inline commentary.
denrase
approved these changes
Jan 7, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
#skip-changelog