Skip to content

Commit 1fc7cc0

Browse files
authored
Add CONTRIBUTING.md for prompt submission guidelines ✍️ (#20)
1 parent 82377ca commit 1fc7cc0

2 files changed

Lines changed: 45 additions & 53 deletions

File tree

CONTRIBUTING.md

Lines changed: 45 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,50 @@
1-
# Contributing
1+
![promptlibrary Banner](https://github.com/user-attachments/assets/247f5479-90ce-4928-a15d-dabeab7797d8)
22

3-
## General requirements
3+
# Contributing to the ServiceNow's GenAI Prompt Library 🎉
44

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.
5+
Thank you for your interest in contributing to the Prompt Library! We appreciate your help in making this resource better for everyone. 🙌
116

12-
## Recommendations
7+
## How to Contribute
138

14-
Need some guidance? The RISEN framework helps structure tasks for generative AI into actionable steps:
9+
### 1. Think of a Prompt 💭
1510

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.")
11+
Consider a prompt you frequently use in your day-to-day work as a ServiceNow professional. This could include:
12+
13+
- Prompts that help write emails ✉️.
14+
- Prompts for generating specific code snippets 💻.
15+
- Prompts that assist in creating documentation 📚.
16+
- Prompts tailored for using providers like ChatGPT with your ServiceNow experience.
17+
18+
For inspiration, you can view the top-voted prompts in the library [here](https://communityresources.service-now.com/ai?id=library&display=10&sort=true).
19+
20+
### 2. Submit a Prompt 📥
21+
22+
To submit your prompt, follow these steps:
23+
24+
#### Creating a New File
25+
26+
1. **Fork the Repository:** Click the "Fork" button at the top right of this page to create your own copy of the repository.
27+
2. **Create a New Branch:** In your forked repository, create a new branch for your prompt submission.
28+
3. **Add a New File:** Navigate to the `Prompts` folder in your branch and create a new file. Make sure to follow the guidelines outlined below to ensure your submission is acceptable.
29+
![Creating a file](https://github.com/user-attachments/assets/64a259da-7ff8-491c-91ba-eddf1414219e)
30+
4. **Submit a Pull Request:** Once your prompt is ready, submit a pull request to the main repository. One of our moderators will review your submission.
31+
32+
<br />
33+
34+
## Guidelines for Submission 📝
35+
36+
- Ensure that your prompt is clear and concise.
37+
- Include any necessary context or examples to help others understand its use.
38+
- Follow the naming conventions and formatting as specified in the repository.
39+
40+
<hr />
41+
42+
### See Your Prompt Live 🌟
43+
44+
Once your submission is accepted, it will immediately appear in the Prompt Library, which can be viewed at [Prompt Library](https://devlink.sn/PromptLibrary).
45+
46+
![Result in Prompt Library](https://github.com/user-attachments/assets/d9606aec-da1c-400c-9ba8-273c663e9807)
47+
48+
Any logged-in user will be able to comment on and vote for your submission, helping to highlight valuable prompts. 👍
49+
50+
### Thank you for contributing to the Prompt Library! We look forward to seeing your creative prompts. 🚀

README.md

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -10,41 +10,3 @@ The Prompt Library itself, is a community-driven hub for ServiceNow professional
1010

1111
Note, this repository _can_ be installed on your ServiceNow instance but contributions to this repository are for **Prompt Submission only**. See [CONTRIBUTING.md](CONTRIBUTING.md) for full details.
1212

13-
## Contributing process
14-
15-
### Think of a prompt
16-
17-
Have a prompt you use often in your day-to-day work as a ServiceNow professional?
18-
19-
Examples:
20-
- Prompts that write emails for you
21-
- Prompts that generate very specific code snippets
22-
- Prompts that help you create documentation
23-
- Prompts that help you tailor providers like ChatGPT to your ServiceNow experience specifically
24-
- Etc.
25-
26-
That's what we're looking for! If you want examples, you can see the top-voted ones at the library at this link: https://communityresources.service-now.com/ai?id=library&display=10&sort=true
27-
28-
### Submit a prompt
29-
30-
In this repository, create a new file in the `Prompts` folder and submit it.
31-
32-
![Creating a file](https://github.com/user-attachments/assets/64a259da-7ff8-491c-91ba-eddf1414219e)
33-
34-
35-
#### How to submit (walkthrough)
36-
37-
1. Fork this repo
38-
2. Create a new branch on your forked repo
39-
3. Add a new file to your `Prompts` folder. Make sure to follow all the instructions on [CONTRIBUTING.md](CONTRIBUTING.md) to ensure your submission is acceptable.
40-
4. Submit a pull request!
41-
42-
One of our moderators will then review your pull request.
43-
44-
### See it live in the Prompt Library
45-
46-
Accepted submissions/pull requests will immediately be visible at the Prompt Library at https://devlink.sn/PromptLibrary
47-
48-
![Result in Prompt Library](https://github.com/user-attachments/assets/d9606aec-da1c-400c-9ba8-273c663e9807)
49-
50-
Any logged in user will be able to comment and vote on your submission!

0 commit comments

Comments
 (0)