EmailContact
Skip to main content

Contributing to UnrealSEO

🎯 Quick Summary​

  • How to contribute to UnrealSEO documentation and community
  • Report bugs, suggest features, submit improvements
  • Documentation guidelines and style guide
  • Community code of conduct and values
  • Recognition and rewards for contributors

📋 Table of Contents​

  1. Ways to Contribute
  2. Documentation Contributions
  3. Bug Reports
  4. Feature Requests
  5. Community Guidelines
  6. Recognition & Rewards

🔑 Key Concepts at a Glance​

  • Open Docs: Documentation is open-source (GitHub)
  • Pull Request: Proposed change submitted for review
  • Issue: Bug report or feature request
  • Contributor: Community member who helps improve UnrealSEO
  • Maintainer: UnrealSEO team member who reviews contributions

🏷️ Metadata​

Tags: contributing, community, guidelines, open-source Status: %%ACTIVE%% Complexity: %%BEGINNER%% Max Lines: 450 (this file: 445 lines) Reading Time: 8 minutes Last Updated: 2025-01-18

Ways to Contribute​

Quick Contribution Options​

No coding required:

1. Improve Documentation (10 min)
   • Fix typos, grammar
   • Clarify confusing sections
   • Add examples
   • Update outdated content

2. Report Bugs (5 min)
   • Found an issue? Report it
   • Include steps to reproduce
   • Screenshots help

3. Request Features (5 min)
   • Share your ideas
   • Explain use case
   • Vote on existing requests

4. Answer Community Questions (15 min)
   • Help others in forum
   • Share your expertise
   • Build reputation

5. Share Case Studies (30 min)
   • Share your success story
   • Include metrics, results
   • Inspire others

6. Write Tutorials (1-2 hours)
   • Create how-to guides
   • Video walkthroughs
   • Industry-specific tips

Coding required:

1. Build Integrations
   • CMS plugins (WordPress, Shopify, etc.)
   • API clients (new languages)
   • Browser extensions

2. Create Tools
   • Schema generators
   • Citation checkers
   • Content analyzers

3. Improve Platform
   • Performance optimizations
   • Bug fixes
   • Feature development

Note: Platform code is NOT open-source
Contact: info@unrealseo.com for collaboration

Documentation Contributions​

How to Edit Documentation​

Simple edits (GitHub Web UI):

Step 1: Find the page to edit
Visit: https://docs.unrealseo.com/any-page

Step 2: Click "Edit this page" (bottom of page)
Redirects to GitHub

Step 3: Make changes
• Click pencil icon (✏️)
• Edit in web editor
• Preview changes

Step 4: Propose changes
• Scroll to bottom
• Add commit message: "Fix typo in robots.txt guide"
• Select: "Create a new branch"
• Click: "Propose changes"

Step 5: Create Pull Request
• Add description of changes
• Click: "Create pull request"
• Wait for review (1-3 business days)

Done! Your contribution will be reviewed.

Complex edits (Local development):

# Fork and clone repository
git clone https://github.com/unrealseo/docs.git
cd docs

# Create branch
git checkout -b fix/improve-schema-guide

# Make changes
# Edit files in docs/

# Test locally (optional)
npm install
npm run dev
# Visit http://localhost:3000

# Commit changes
git add .
git commit -m "Improve schema implementation guide with examples"

# Push to your fork
git push origin fix/improve-schema-guide

# Create Pull Request on GitHub
# Visit your fork on GitHub → "Compare & pull request"

Documentation Style Guide​

Writing style:

✓ Clear and concise
✓ Active voice ("Click the button" not "The button should be clicked")
✓ Second person ("You can..." not "One can...")
✓ Present tense ("This feature allows..." not "This feature will allow...")
✓ Specific ("Increases citation rate by 15%" not "Improves performance")

✗ Avoid jargon (or define it first)
✗ No marketing speak ("revolutionary," "game-changing")
✗ No absolute claims without data ("always," "never")

Formatting:

# Use H1 for page title (one per page)

## Use H2 for major sections

### Use H3 for subsections

**Bold** for emphasis, UI elements ("Click **Save**")

*Italic* for references, terms ("See *Getting Started*")

`Code` for inline code, filenames, commands

```block
Multi-line code blocks
With syntax highlighting
  • Bullet lists for unordered items
  1. Numbered lists for sequential steps

Blockquotes for important notes

Example link descriptive link text


**Code examples:**

Include: ✓ Complete, working examples ✓ Comments explaining non-obvious parts ✓ Error handling ✓ Expected output

Avoid: ✗ Pseudocode (use real code) ✗ Incomplete snippets ✗ Undeclared variables ✗ Hardcoded secrets (use placeholders)


### Content Requirements

**Every documentation page must have:**

```markdown
# Page Title %%PRIORITY:HIGH|MEDIUM|LOW%%

## 🎯 Quick Summary
- Bullet points (3-5)
- What user will learn
- Key takeaways

## 📋 Table of Contents
1. [Section 1](#section-1)
2. [Section 2](#section-2)

## 🔑 Key Concepts at a Glance
- Term: Definition
- Term: Definition

## 🏷️ Metadata
**Tags**: `tag1, tag2, tag3`
**Status**: %%ACTIVE|DEPRECATED|BETA%%
**Complexity**: %%BEGINNER|MODERATE|ADVANCED%%
**Reading Time**: X minutes
**Last Updated**: YYYY-MM-DD

---

[Main content sections]

---

## 📚 Related Topics
- [Link to related doc](path)

---

## 🆘 Need Help?
- Support resources

---

_Last updated: YYYY-MM-DD | [Edit this page](github-url)_

Bug Reports​

How to Report Bugs​

Good bug report template:

## Bug Description
Clear, concise description of the bug

## Steps to Reproduce
1. Go to Query Explorer
2. Click "Test Query"
3. Enter query: "CRM software"
4. Click "Test Now"
5. See error

## Expected Behavior
Should show citation status across 4 platforms

## Actual Behavior
Shows "Error: Platform timeout" for all platforms

## Environment
- Plan: Pro
- Browser: Chrome 120.0
- OS: macOS 14.2
- Date/Time: 2025-01-18 14:30 UTC

## Screenshots
[Attach screenshot of error]

## Additional Context
- Happens 100% of the time
- Started after Jan 15 update
- Other queries work fine

Where to report:

Platform Bugs:
→ https://community.unrealseo.com/bugs
→ info@unrealseo.com (for urgent/security issues)

Documentation Bugs:
→ https://github.com/unrealseo/docs/issues
→ Click "Edit this page" → Create issue

API Bugs:
→ https://github.com/unrealseo/unrealseo-api/issues
→ info@unrealseo.com

Bug Priority Levels​

🔴 Critical (P0): Fix within 24 hours
• Platform down
• Data loss
• Security vulnerability
• Payment issues

🟠 High (P1): Fix within 1 week
• Core feature broken
• Incorrect data
• Performance degradation

🟡 Medium (P2): Fix within 1 month
• Minor feature broken
• Workaround exists
• UI glitches

🟢 Low (P3): Fix when possible
• Cosmetic issues
• Nice-to-have improvements
• Edge cases

Feature Requests​

How to Request Features​

Feature request template:

## Feature Name
Schema Bulk Generator

## Problem Statement
Manually adding schema to 500+ pages takes too long (2 hours per page = 1000 hours total)

## Proposed Solution
Bulk schema generation tool:
1. Select content type (blog posts, product pages, etc.)
2. Choose schema type (FAQPage, Article, HowTo)
3. Click "Generate for All"
4. Review and apply

## Use Case
E-commerce site with 2,000 product pages
Need Product schema on all pages
Manual implementation: 4,000 hours
Bulk tool: 4 hours (99.9% time saved)

## Expected Impact
- Time saved: 99%+
- Citation rate increase: +20-30pp (based on case studies)
- Would pay: $500/year for this feature

## Alternatives Considered
- Manual schema addition (too slow)
- Hire developer (expensive, $5K+)
- Third-party tool (doesn't integrate)

## Willingness to Beta Test
Yes, can provide 2,000-page site for testing

Submission:

1. Community Forum (public voting):
   https://community.unrealseo.com/feature-requests

2. Email (direct to product team):
   info@unrealseo.com

3. In-App (for logged-in users):
   Dashboard → Help → Request Feature

Community Guidelines​

Code of Conduct​

Our values:

1. Be Respectful
   ✓ Treat everyone with respect
   ✓ Welcome diverse perspectives
   ✓ Assume good intent

   ✗ No harassment, discrimination
   ✗ No personal attacks
   ✗ No trolling

2. Be Helpful
   ✓ Share knowledge generously
   ✓ Help beginners
   ✓ Provide constructive feedback

   ✗ No gatekeeping
   ✗ No "RTFM" responses
   ✗ No making others feel stupid

3. Be Collaborative
   ✓ Give credit to others
   ✓ Build on others' work
   ✓ Seek win-win solutions

   ✗ No plagiarism
   ✗ No taking undue credit
   ✗ No zero-sum thinking

4. Be Professional
   ✓ Stay on topic
   ✓ Use appropriate language
   ✓ Respect confidentiality

   ✗ No spam or self-promotion
   ✗ No profanity
   ✗ No sharing others' private data

Enforcement​

Violations:

First offense: Warning
• Private message from moderator
• Explanation of violation
• Guidance on improvement

Second offense: Temporary ban (7 days)
• Account temporarily suspended
• Time to reflect

Third offense: Permanent ban
• Account permanently banned
• No appeals

Severe violations (harassment, threats, doxxing):
• Immediate permanent ban
• Reported to authorities if applicable

Appeals:

Contact: info@unrealseo.com

Include:
• Your username
• Date of action
• Explanation of circumstances
• What you'll do differently

Response time: 5 business days

Recognition & Rewards​

Contributor Levels​

Bronze Contributor (5+ contributions):

  • Profile badge
  • Listed on Contributors page
  • Early access to beta features

Silver Contributor (25+ contributions):

  • All Bronze benefits
  • Free Pro plan (1 year, $588 value)
  • Quarterly swag shipment
  • Private Slack channel access

Gold Contributor (100+ contributions):

  • All Silver benefits
  • Free Enterprise plan (1 year, $3,588 value)
  • Annual contributor summit (all-expenses paid)
  • Advisor role (influence roadmap)
  • Custom integrations support

Hall of Fame (500+ contributions):

  • All Gold benefits
  • Lifetime Enterprise plan (forever free)
  • Personal meeting with CEO/founders
  • Co-author credit on major features
  • Revenue share on contributed features

Current Top Contributors​

🏆 Gold Contributors:

1. Sarah Chen (@sarahchen)
   • 342 contributions
   • Focus: Documentation, tutorials
   • Impact: 1.2M doc views attributed

2. Marcus Webb (@marcuswebb)
   • 287 contributions
   • Focus: Code examples, integrations
   • Impact: WordPress plugin (40K installs)

3. Emily Rodriguez (@emilyrodriguez)
   • 234 contributions
   • Focus: Community support, testing
   • Impact: Answered 1,200+ questions

🥈 Silver Contributors: 23 members
🥉 Bronze Contributors: 187 members

Join them! Start contributing today.

Contribution Types & Points​

Activity                        Points
-----------------------------------
Fix typo                        1
Improve documentation           5
Create tutorial                 25
Build integration               100
Answer forum question           2
Report bug (confirmed)          5
Feature request (implemented)   50
Significant code contribution   200

Redeem points for:
• Swag (t-shirts, stickers): 50 pts
• Pro plan (1 month): 100 pts
• Conference ticket: 500 pts
• 1-on-1 with team: 1,000 pts

📚 Related Topics​

Community:

Support:

🤝 Get Started Contributing​

Easy First Contributions:

Join the Community:

🆘 Questions?​

Contributing Questions:

Last updated: 2025-01-18 | Edit this page

Last updated on