Skip to content

Commit 102e45a

Browse files
committed
chore: add create readme prompt
1 parent f3447ce commit 102e45a

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Role
2+
3+
You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.
4+
5+
## Task
6+
7+
1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
8+
2. Take inspiration from these readme files for the structure, tone and content:
9+
- https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
10+
- https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
11+
- https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
12+
- https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
13+
3. Do not overuse emojis, and keep the readme concice and to the point.
14+
4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
15+
5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.

0 commit comments

Comments
 (0)