awesome-chatgpt-prompts/CONTRIBUTING.md

67 lines
2.7 KiB
Markdown
Raw Normal View History

2023-02-09 21:44:26 +00:00
# Contribution Guidelines
2025-02-04 23:54:53 +00:00
Before contributing to this repository, please ensure you are adhering to the
following general guidelines. Further, if you are submitting a new prompt to the
repository, be sure you are also following the prompt-specific guidelines. These
checks will ensure that your contributions can be easily integrated into the
main repository, without any headache for the owners.
2023-02-09 21:44:26 +00:00
## General Guidelines
2025-02-04 23:54:53 +00:00
The following guidelines should be followed when making any open-source
contributions:
- [ ] Contributions should be made via a pull request to the main repository
from a personal fork.
- [ ] Pull requests should be accompanied by a descriptive title and detailed
explanation.
2023-02-09 21:44:26 +00:00
- [ ] Submit all pull requests to the repository's main branch.
2025-02-04 23:54:53 +00:00
- [ ] Before submitting a pull request, ensure additions/edits are aligned with
the overall repo organization.
2023-02-09 21:44:26 +00:00
- [ ] Be sure changes are compatible with the repository's license.
2025-02-04 23:54:53 +00:00
- [ ] In case of conflicts, provide helpful explanations regarding your proposed
changes so that they can be approved by repo owners.
2023-02-09 21:44:26 +00:00
## New Prompt Guidelines
2025-02-04 23:54:53 +00:00
To add a new prompt to this repository, a contributor should take the following
steps (in their personal fork):
2023-02-09 21:44:26 +00:00
1. Create and test the new prompt.
2025-02-04 23:54:53 +00:00
- See the
[README](https://github.com/f/awesome-chatgpt-prompts/blob/main/README.md)
for guidance on how to write effective prompts.
- Ensure prompts generate intended results and can be used by other users to
replicate those results.
2023-02-09 21:44:26 +00:00
2. Add the prompt to `README.md` using the following markdown template:
2025-02-04 23:54:53 +00:00
`## Prompt Title`
2023-02-09 21:44:26 +00:00
2025-02-04 23:54:53 +00:00
`Contributed by: [@github_username](https://github.com/github_profile)`
2023-02-09 21:44:26 +00:00
2025-02-04 23:54:53 +00:00
`> prompt content`
2023-02-09 21:44:26 +00:00
2025-02-04 23:54:53 +00:00
- <b>Note:</b> If your prompt was generated by ChatGPT, append
`<mark>Generated by ChatGPT</mark>` to the "Contributed by" line.
2023-02-09 21:44:26 +00:00
3. Add the prompt to `prompts.csv`.
2025-02-04 23:54:53 +00:00
- Put the prompt title in the `act` column, and the prompt itself in the
`prompt` column.
2023-02-09 21:44:26 +00:00
4. Submit a pull request on the repository's main branch.
2025-02-04 23:54:53 +00:00
- If possible, provide some documentation of how you tested your prompt and
the kinds of results you received.
- Be sure to include a detailed title and description.
2023-02-09 21:52:45 +00:00
### New Prompt Checklist:
2025-02-04 23:54:53 +00:00
2023-02-09 21:52:45 +00:00
- [ ] I've confirmed the prompt works well
2025-02-04 23:54:53 +00:00
- [ ] I've added
`Contributed by: [@yourusername](https://github.com/yourusername)`
2023-02-09 21:52:45 +00:00
- [ ] I've added to the README.md
- [ ] I've added to the `prompts.csv`
- [ ] Escaped quotes by double-quoting them
2025-02-04 23:54:53 +00:00
- [ ] No spaces after commas after double quotes. e.g. `"act","prompt"` not
`"act", "prompt"`
2023-02-09 21:52:45 +00:00
- [ ] Removed "Act as" from the title on CSV
Please ensure these requirements are met before submitting a pull request.