docs(CONTRIBUTING.md): update contribution guidelines and instructions
This commit is contained in:
+37
-51
@@ -1,66 +1,52 @@
|
||||
# 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.
|
||||
Thank you for your interest in contributing to Awesome ChatGPT Prompts!
|
||||
|
||||
## General Guidelines
|
||||
## How to Contribute
|
||||
|
||||
The following guidelines should be followed when making any open-source
|
||||
contributions:
|
||||
The easiest way to contribute is through **[prompts.chat](https://prompts.chat)**:
|
||||
|
||||
- [ ] 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.
|
||||
1. Visit [prompts.chat](https://prompts.chat)
|
||||
2. Sign in with your GitHub account
|
||||
3. Create and submit your prompt
|
||||
4. Your contribution will automatically sync to this repository
|
||||
|
||||
## New Prompt Guidelines
|
||||
Your GitHub username will be credited as the contributor, and you'll appear in the repository's contributors list.
|
||||
|
||||
To add a new prompt to this repository, a contributor should take the following
|
||||
steps (in their personal fork):
|
||||
## Prompt Guidelines
|
||||
|
||||
1. Create and test the new prompt.
|
||||
- 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:
|
||||
When creating a new prompt:
|
||||
|
||||
`## Prompt Title`
|
||||
- **Test your prompt** - Ensure it generates intended results and can be used by others
|
||||
- **Be descriptive** - Give your prompt a clear, concise title
|
||||
- **Be original** - Don't submit duplicates of existing prompts
|
||||
- **Be appropriate** - Keep content suitable for all audiences
|
||||
|
||||
`Contributed by: [@github_username](https://github.com/github_profile)`
|
||||
## Direct Contributions
|
||||
|
||||
`> prompt content`
|
||||
For bug fixes, documentation improvements, or other non-prompt contributions:
|
||||
|
||||
- <b>Note:</b> If your prompt was generated by ChatGPT, append
|
||||
`<mark>Generated by ChatGPT</mark>` 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.
|
||||
1. Fork the repository
|
||||
2. Create a branch for your changes
|
||||
3. Submit a pull request with a descriptive title and explanation
|
||||
|
||||
### New Prompt Checklist:
|
||||
## Prompt CSV Format
|
||||
|
||||
- [ ] 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
|
||||
- [ ] No spaces after commas after double quotes. e.g. `"act","prompt"` not
|
||||
`"act", "prompt"`
|
||||
- [ ] Removed "Act as" from the title on CSV
|
||||
If you're contributing directly to `prompts.csv`, follow this format:
|
||||
|
||||
Please ensure these requirements are met before submitting a pull request.
|
||||
| Column | Description |
|
||||
|--------|-------------|
|
||||
| `act` | Prompt title (without "Act as" prefix) |
|
||||
| `prompt` | The full prompt text |
|
||||
| `for_devs` | `TRUE` or `FALSE` - is this for developers? |
|
||||
| `type` | `TEXT` or `STRUCTURED` |
|
||||
| `contributor` | Your GitHub username |
|
||||
|
||||
**CSV Rules:**
|
||||
- Escape quotes by double-quoting them (`""`)
|
||||
- No spaces after commas inside quoted fields
|
||||
- Use your GitHub username exactly as it appears
|
||||
|
||||
## Questions?
|
||||
|
||||
Open an issue if you have questions about contributing.
|
||||
|
||||
Reference in New Issue
Block a user