1
1
# Introduction
2
2
3
- > ** Note on Document Formatting:** This document (` Jules .md` ) should be
3
+ > ** Note on Document Formatting:** This document (` AGENTS .md` ) should be
4
4
> maintained with lines word-wrapped to a maximum of 80 characters to ensure
5
5
> readability across various editors and terminals.
6
6
@@ -574,7 +574,7 @@ prevent memory leaks, dangling pointers, or double deletions.
574
574
This document is a living guide. As the Firebase C++ SDK evolves, new patterns
575
575
may emerge, or existing practices might change. If you introduce a new common
576
576
pattern, significantly alter a build process, or establish a new best practice
577
- during your work, please take a moment to update this ` Jules .md` file
577
+ during your work, please take a moment to update this ` AGENTS .md` file
578
578
accordingly.
579
579
580
580
Keeping this document current will greatly benefit future AI agents and human
@@ -584,39 +584,39 @@ developers working on this repository.
584
584
585
585
## Recommended General Prompt Instruction
586
586
587
- When working on this task, please consistently refer to the ` Jules .md` guide
587
+ When working on this task, please consistently refer to the ` AGENTS .md` guide
588
588
for all repository-specific conventions, including setup procedures, coding
589
589
style, common architectural patterns, and API usage. Pay close attention to the
590
590
testing strategies outlined, ensuring your implementation includes
591
591
comprehensive integration tests with detailed test cases in your plan. Implement
592
592
robust error handling for any new or modified public API methods, following the
593
593
patterns for ` firebase::Future ` error reporting. If the feature involves
594
594
platform-specific code, ensure the public API remains consistent across all
595
- platforms, as discussed in ` Jules .md` . Write clear, maintainable code,
595
+ platforms, as discussed in ` AGENTS .md` . Write clear, maintainable code,
596
596
adhering to the commenting guidelines, and if you need to add new third-party
597
597
dependencies, document the rationale and update build configurations according
598
598
to the established practices. Ensure your changes align with the overall best
599
- practices detailed in ` Jules .md` .
599
+ practices detailed in ` AGENTS .md` .
600
600
601
601
## Key Directives for Jules AI
602
602
603
- * ** Prioritize ` Jules .md` ** : This document (` Jules .md` ) contains
603
+ * ** Prioritize ` AGENTS .md` ** : This document (` AGENTS .md` ) contains
604
604
repository-specific guidelines. Prioritize this information when making
605
605
decisions about coding style, testing procedures, architectural patterns,
606
606
and API usage.
607
607
* ** Adherence to Patterns** : Strive to follow the common patterns and best
608
608
practices outlined here. This ensures consistency across the codebase.
609
- * ** Clarification for Deviations** : If the existing patterns in ` Jules .md` do
609
+ * ** Clarification for Deviations** : If the existing patterns in ` AGENTS .md` do
610
610
not seem suitable for a specific task, or if a deviation is necessary,
611
611
please explicitly state this in your plan or request clarification before
612
612
proceeding with implementation.
613
- * ** Updating ` Jules .md` ** : If you introduce a new, broadly applicable
613
+ * ** Updating ` AGENTS .md` ** : If you introduce a new, broadly applicable
614
614
pattern, or if a significant change to the build process or best practices
615
615
occurs as part of your task, please include a step in your plan to update
616
- ` Jules .md` to reflect these changes.
616
+ ` AGENTS .md` to reflect these changes.
617
617
* ** Testing** : Remember that integration tests are the primary method of
618
618
testing. Ensure new features are accompanied by corresponding integration
619
- tests as described in the 'Testing' section of ` Jules .md` .
619
+ tests as described in the 'Testing' section of ` AGENTS .md` .
620
620
* ** Commit Messages** : Follow standard commit message guidelines. A brief
621
621
summary line, followed by a more detailed explanation if necessary.
622
622
* ** Tool Limitations & Path Specificity** : If codebase search tools (like
0 commit comments