Contribution Guide

Help improve the wiki! All contributions are welcome, from fixing typos to adding complete guides.

How to Contribute

1. Fork the Repository

Visit our GitHub repository and click "Fork" to create your own copy.

2. Clone Your Fork

git clone https://github.com/YOUR-USERNAME/wherewindsmeet-wiki.git
cd wherewindsmeet-wiki
npm install

3. Create a Branch

git checkout -b feature/your-contribution-name

4. Make Your Changes

Edit files, add content, fix bugs. Test locally with:

npm run dev

5. Commit and Push

git add .
git commit -m "Description of your changes"
git push origin feature/your-contribution-name

6. Create Pull Request

Go to GitHub and create a Pull Request from your branch to our main branch.

Content Guidelines

Writing Style

  • Use clear, concise language
  • Write in second person ("you" not "the player")
  • Use proper grammar and spelling
  • Be encouraging and positive
  • Avoid jargon without explanation

Guide Structure

  • Start with brief overview (1-2 sentences)
  • Use descriptive headers (##, ###)
  • Keep sections focused (2-3 paragraphs)
  • Include examples where helpful
  • Add tips and warnings as needed

Formatting

  • Use Markdown for all content
  • Bold sparingly (max 3 consecutive words)
  • Use lists for steps or options
  • Include code blocks for commands
  • Add images with descriptive alt text

What to Contribute

📝 Guides

Write new guides for weapons, builds, quests, or game mechanics. Check existing guides for format examples.

🗃️ Database Entries

Add missing weapons, NPCs, quests, or bosses to JSON files in src/data/.

🔧 Fixes & Updates

Correct outdated information, fix typos, improve unclear explanations.

🖼️ Images

Provide high-quality screenshots for guides, weapons, locations. Use PNG or WebP format.

🧮 Tools & Calculators

Improve existing calculators or suggest new interactive tools for the community.

🎨 Design & UX

Suggest UI improvements, accessibility enhancements, or mobile optimizations.

Review Process

  1. Submit Pull Request with clear description of changes
  2. Maintainer Review within 48 hours (usually faster)
  3. Address Feedback if any changes are requested
  4. Approval & Merge once everything looks good
  5. Automatic Deployment to live site within minutes

Tips for Faster Review:

  • Keep changes focused and atomic
  • Write clear commit messages
  • Test your changes locally first
  • Follow existing code/content patterns
  • Include screenshots for UI changes

Recognition

All contributors are recognized in our:

  • Contributors Page - Hall of fame for all helpers
  • GitHub Contributors - Automatic GitHub recognition
  • Discord Role - Special contributor role in our community
  • Release Notes - Credit in major update announcements

Community & Support

Need help or have questions? We're here to support you:

Ready to Contribute?

Every contribution, no matter how small, helps make this wiki better for everyone!