You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/prompts/create-agents.md.prompt.md
+24-9Lines changed: 24 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,50 +24,64 @@ When creating the `AGENTS.md` file, prioritize clarity, completeness, and action
24
24
## Instructions
25
25
26
26
1. Examine the current project to understand its context, requirements, constraints, architecture, tech stack and specificities, and any existing files that may provide insights.
27
-
- For example, look for files that may contain the project name, idea, vision, requirements, technology stack and constraints. This may include README files, project documentation, configuration files (e.g., package.json, pyproject.toml, etc.), CI/CD workflows and any other relevant files.
28
-
- If the project is a monorepo or has multiple distinct project roots, identify the relevant subdirectories that may require their own `AGENTS.md` files.
27
+
28
+
- For example, look for files that may contain the project name, idea, vision, requirements, technology stack and constraints. This may include README files, project documentation, configuration files (e.g., package.json, pyproject.toml, etc.), CI/CD workflows and any other relevant files.
29
+
- If the project is a monorepo or has multiple distinct project roots, identify the relevant subdirectories that may require their own `AGENTS.md` files.
29
30
30
31
2. Once you have all the necessary information, create or update the `AGENTS.md` file with all relevant project context, requirements, stack and constraints for the code agents that will implement the project.
31
-
- When doing so, use this the template for structuring the document:
32
+
33
+
- When doing so, use this the template for structuring the document:
34
+
32
35
```md
33
36
# [project_name]
37
+
34
38
[Project summary]
35
39
36
40
## Overview
41
+
37
42
- [Brief description of what the project does, its purpose and audience]
38
43
- [Architecture overview if complex]
39
44
- [Project structure if relevant]
40
45
41
46
## Key Technologies and Frameworks
47
+
42
48
- [List of main technologies, frameworks, and libraries used in the project]
43
49
44
50
## Constraints and Requirements [if any]
51
+
45
52
- [Any specific constraints, requirements, or considerations for the project]
46
53
47
54
## Challenges and Mitigation Strategies [if any]
55
+
48
56
- [Potential challenges and how they will be addressed]
49
57
50
58
## Development Workflow [if applicable]
59
+
51
60
- [Most important scripts, commands, and tools for development, testing, and deployment. How to start dev server, run tests, build for production, etc.]
52
61
53
62
## Coding Guidelines [if any]
63
+
54
64
- [Any specific coding standards, style guides, or best practices to follow]
55
65
56
66
## Security Considerations [if any]
67
+
57
68
- [Any security practices or considerations relevant to the project]
58
69
59
70
## Pull Request Guidelines [if any]
71
+
60
72
- [Any specific guidelines for creating pull requests, such as, title format, required checks, review process, commit message conventions, etc.]
- **Be specific and concise**: include exact commands, and information from the provided context, do not make any assumptions or add unnecessary details.
67
-
- Only use information you found to fill the sections.
68
-
- Use standard Markdown formatting.
69
-
- If needed, you can add specific sections relevant to the project that are not covered by the template if they provide important context for the code agents.
70
-
- If the file already contains enough relevant information, you can skip this step.
78
+
79
+
- If a section is not relevant, you can omit it.
80
+
- **Be specific and concise**: include exact commands, and information from the provided context, do not make any assumptions or add unnecessary details.
81
+
- Only use information you found to fill the sections.
82
+
- Use standard Markdown formatting.
83
+
- If needed, you can add specific sections relevant to the project that are not covered by the template if they provide important context for the code agents.
84
+
- If the file already contains enough relevant information, you can skip this step.
71
85
72
86
## Best Practices
73
87
@@ -81,6 +95,7 @@ When creating the `AGENTS.md` file, prioritize clarity, completeness, and action
81
95
## Monorepo Considerations
82
96
83
97
For large monorepos:
98
+
84
99
- Place a main `AGENTS.md` at the repository root
85
100
- Create additional `AGENTS.md` files in subproject directories if they have distinct contexts, requirements or constraints
86
101
- The closest `AGENTS.md` file takes precedence for any given location
Create a prompt for gpt-image-1 to generate a professional social media banner suitable for OpenGraph, Twitter, and other social sharing platforms. Context and inspiration: <QUERY>.
77
72
Do not use the context words directly as text in the banner, but rather as inspiration for the design.
78
-
${env.vars.text ? `Include the text: "${env.vars.text}" in the banner.` : ""}
73
+
${env.vars.text ? `Include the text: "${env.vars.text}" in the banner.` : ''}
79
74
Target aspect ratio is 2:1 ratio - design for this ratio and make it fit the actual size of 1536x1024 pixels, using black bars.
80
75
Characteristics of the banner: Modern, professional, visually appealing for social media, bright colors, clean design, readable text elements if any, suitable for software project promotion.
81
76
The banner should work well as a social media preview image and represent the project effectively.
0 commit comments