From 8ed572bdad9bf5c4ebf18fdc7a55ae3a7a50ac3c Mon Sep 17 00:00:00 2001 From: Jake Richard Date: Thu, 9 Feb 2023 16:44:26 -0500 Subject: [PATCH 1/4] Added CONTRIBUTING.md --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c2be782 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# Contribution Guidelines +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. + +## General Guidelines +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. +- [ ] Submit all pull requests to the repository's main branch. +- [ ] Before submitting a pull request, ensure additions/edits are aligned with the overall repo organization. +- [ ] Be sure changes are compatible with the repository's license. +- [ ] In case of conflicts, provide helpful explanations regarding your proposed changes so that they can be approved by repo owners. + +## New Prompt Guidelines +To add a new prompt to this repository, a contributor should take the following steps (in their personal fork): +1. Create and test the new prompt. + - See the README for guidance on how to write effective prompts. + - Ensure prompts generate intended results and can be used by other users to replicate those results. +

+2. Add the prompt to `README.md` using the following markdown template: + + `## Prompt Title` + + `Contributed by: [@github_username](https://github.com/github_profile)` + + `> prompt content` + + - Note: If your prompt was generated by ChatGPT, append `Generated by ChatGPT` to the "Contributed by" line. +

+3. Add the prompt to `prompts.csv`. + - Put the prompt title in the `act` column, and the prompt itself in the `prompt` column. +

+4. Submit a pull request on the repository's main branch. + - 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. From 0383a449b4fd39e5d264f5e7510f7eae4ee94e50 Mon Sep 17 00:00:00 2001 From: Jake Richard <64998241+jaARke@users.noreply.github.com> Date: Thu, 9 Feb 2023 16:47:03 -0500 Subject: [PATCH 2/4] Fixed CONTRIBUTING.md spacing --- CONTRIBUTING.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2be782..9901edf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,6 @@ To add a new prompt to this repository, a contributor should take the following 1. Create and test the new prompt. - See the README for guidance on how to write effective prompts. - Ensure prompts generate intended results and can be used by other users to replicate those results. -

2. Add the prompt to `README.md` using the following markdown template: `## Prompt Title` @@ -25,10 +24,8 @@ To add a new prompt to this repository, a contributor should take the following `> prompt content` - Note: If your prompt was generated by ChatGPT, append `Generated by ChatGPT` to the "Contributed by" line. -

3. Add the prompt to `prompts.csv`. - Put the prompt title in the `act` column, and the prompt itself in the `prompt` column. -

4. Submit a pull request on the repository's main branch. - 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. From 9db554d285cabfd745742070a7a9cd8412916f48 Mon Sep 17 00:00:00 2001 From: Jake Richard <64998241+jaARke@users.noreply.github.com> Date: Thu, 9 Feb 2023 16:48:21 -0500 Subject: [PATCH 3/4] Added README link to CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9901edf..348b856 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ The following guidelines should be followed when making any open-source contribu ## New Prompt Guidelines To add a new prompt to this repository, a contributor should take the following steps (in their personal fork): 1. Create and test the new prompt. - - See the README for guidance on how to write effective prompts. + - 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. 2. Add the prompt to `README.md` using the following markdown template: From 2039583c8f36fc1a2fa859369ce7eef50f8cc1bc Mon Sep 17 00:00:00 2001 From: Jake Richard <64998241+jaARke@users.noreply.github.com> Date: Thu, 9 Feb 2023 16:52:45 -0500 Subject: [PATCH 4/4] Updated CONTRIBUTING.md --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 348b856..6500ef4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,3 +29,13 @@ To add a new prompt to this repository, a contributor should take the following 4. Submit a pull request on the repository's main branch. - 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. + +### New Prompt Checklist: +- [ ] I've confirmed the prompt works well +- [ ] I've added `Contributed by: [@yourusername](https://github.com/yourusername)` +- [ ] I've added to the README.md +- [ ] I've added to the `prompts.csv` + - [ ] Escaped quotes by double-quoting them + - [ ] Removed "Act as" from the title on CSV + +Please ensure these requirements are met before submitting a pull request.