Skip to content

Commit dbd1130

Browse files
committed
updated CONTRIBUTING.md
1 parent 6bdd1e7 commit dbd1130

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

CONTRIBUTING.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,9 @@ For new notebooks or significant additions to existing ones, please follow this
7171
7272
1. **Title and Overview:** Clear title and brief overview of the agent.
7373
74-
2. **Required Packages:** Include all necessary package installations at the beginning of the notebook using pip install commands. For example:
75-
```python
76-
!pip install package1
77-
!pip install package2
78-
```
79-
80-
3. **Detailed Explanation:** Cover motivation, key components, agent architecture, and benefits.
74+
2. **Detailed Explanation:** Cover motivation, key components, agent architecture, and benefits.
8175
82-
4. **Visual Representation:** Include a diagram to visualize the agent's architecture. We recommend using Mermaid syntax for creating these diagrams. Here's how to do it:
76+
3. **Visual Representation:** Include a diagram to visualize the agent's architecture. We recommend using Mermaid syntax for creating these diagrams. Here's how to do it:
8377
8478
• Create a graph using Mermaid's graph TD (top-down) syntax
8579
• You can use Claude or other AI assistants to help you design the graph if needed
@@ -94,6 +88,12 @@ For new notebooks or significant additions to existing ones, please follow this
9488

9589
This process ensures consistency in our visual representations and makes it easy for others to understand and potentially modify the diagrams in the future.
9690

91+
4. **Required Packages:** Include all necessary package installations at the beginning of the implementation section using pip install commands. For example:
92+
```python
93+
!pip install package1
94+
!pip install package2
95+
```
96+
9797
5. **Implementation:** Step-by-step Python implementation with clear comments and explanations.
9898

9999
6. **Usage Example:** Demonstrate the agent with a practical example.

0 commit comments

Comments
 (0)