Skip to content

Commit 1b8e82f

Browse files
authored
Create CONTRIBUTING.md
1 parent a1f7339 commit 1b8e82f

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Contributing
2+
3+
## General requirements
4+
5+
- Pull requests should be **only** to add or modify files inside the `Prompts` folder.
6+
- The filename **must** be a description of what the prompt does.
7+
- Filenames should not have special characters that are not allowed on normal file systems (eg. do not put ! in the file name).
8+
- No low-effort submissions.
9+
- example of low-effort: "Generate discussion topics about ServiceNow"
10+
- example of good-effort: including an example of what you are looking for, giving context of what this will be used for, giving a goal with the prompt, adding what kind of audience would be benefitting from this, etc.
11+
12+
## Recommendations
13+
14+
Need some guidance? The RISEN framework helps structure tasks for generative AI into actionable steps:
15+
16+
- **R** — Role: Define the AI's role. (e.g., "Act as an agile coach.")
17+
- **I** — Instructions: Provide clear instructions. (e.g., "Write a guide on crafting a good agile development story.")
18+
- **S** — Steps: Outline specific steps. (e.g., "Start with a user persona, describe the user's goal, list the tasks to achieve the goal, and define the acceptance criteria.")
19+
- **E** — End goal: State the goal and audience. (e.g., "Help team members understand how to write clear and effective agile stories.")
20+
- **N** — Narrowing: Add constraints. (e.g., "Max 800 words, avoid technical jargon, use practical examples.")

0 commit comments

Comments
 (0)