Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
126 lines (87 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

126 lines (87 loc) · 3.14 KB

Contributing to Validate Information with LLMs

Thank you for your interest in contributing! This guide will help you get started.

Ways to Contribute

1. Translate Prompts

Help us reach researchers worldwide by translating prompts to your language.

Current languages:

  • English (complete)
  • Hungarian (in progress)

Wanted:

  • Spanish, German, French, Chinese, Japanese, Portuguese

2. Submit New Prompts

Share your research workflow enhancements.

Requirements:

  • Follow the 5-section template (see below)
  • Include English AND native language summary
  • Test with at least 2 LLMs (Claude, GPT, Perplexity)
  • Provide PRO/CONTRA analysis

3. Improve Existing Prompts

  • Add edge cases to PRO/CONTRA analysis
  • Suggest better phrasing for clarity
  • Report issues with specific LLMs

4. Share Examples

  • Real output examples (anonymized)
  • Case studies from your research
  • Discipline-specific adaptations

Prompt Template

All prompts must follow this structure:

# **[Phase Name]**

_________________________________________________________________________________________________
> **Goal:** [Clear statement of what this prompt achieves]
_________________________________________________________________________________________________

#### **1. Original Prompt Block (English)**

> "[The basic version of the prompt]"

#### **2. Analysis & Strategy**

| Phase | Insight |
| :--- | :--- |
| **Analysis** | [What the prompt does and why] |
| **Review** | [Potential issues and considerations] |
| **Brainstorming** | [Suggestions for improvement] |

#### **3. PRO / CONTRA Analysis**

| **PRO (Advantages)** | **CONTRA (Risks)** |
| :--- | :--- |
| [Benefit 1] | [Risk 1] |
| [Benefit 2] | [Risk 2] |

#### **4. Upgraded Prompt**

**Changes Made:** [List of improvements]

> **Copy & Paste this Prompt:**
>
> "[The improved prompt]"

#### **5. Hungarian Summary & Best Usage**

| Kategória | Leírás |
| :--- | :--- |
| **Mire a legjobb?** | [Best use case in Hungarian] |
| **Valós példa** | [Real example in Hungarian] |

Submission Process

For Bug Reports / Issues

  1. Open an issue using the template
  2. Describe what went wrong
  3. Include the LLM and version used

For New Prompts / Improvements

  1. Fork the repository
  2. Create a branch: git checkout -b feature/your-feature
  3. Make your changes
  4. Test with at least 2 LLMs
  5. Submit a Pull Request

Quality Checklist

Before submitting, ensure:

  • Prompt follows the 5-section template
  • PRO/CONTRA analysis is balanced (not just positive)
  • Tested with Claude AND GPT-4 or Perplexity
  • No hallucinated citations in examples
  • Hungarian summary included (or request translation help)
  • File naming follows convention: XX-prompt-name.md

Code of Conduct

  • Be respectful and constructive
  • Focus on academic integrity
  • Cite sources when referencing other work
  • Do not present AI outputs as original research without disclosure

Questions?

Open an issue with the "question" label or start a discussion.