> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rtfm.guide/llms.txt
> Use this file to discover all available pages before exploring further.

# Community Guidelines

> Rules and expectations for being part of the RTFM.guide community

## Our Mission

RTFM.guide exists to make developers' lives easier by providing practical, accurate, and accessible coding guides. Our community guidelines ensure this remains a helpful, respectful, and safe space for everyone.

## Core Values

<CardGroup cols={2}>
  <Card title="Be Helpful" icon="hands-helping">
    Share knowledge generously. Write clearly. Solve problems.
  </Card>

  <Card title="Be Respectful" icon="handshake">
    Treat everyone with kindness. Assume good intent. Stay professional.
  </Card>

  <Card title="Be Accurate" icon="check">
    Test your code. Verify information. Update when needed.
  </Card>

  <Card title="Be Original" icon="lightbulb">
    Credit sources. Don't plagiarize. Add your own insights.
  </Card>
</CardGroup>

## General Conduct

### Do's ✅

* **Be constructive**: Provide actionable feedback
* **Be patient**: Remember everyone is learning
* **Be inclusive**: Welcome developers of all skill levels
* **Be humble**: Admit mistakes and learn from them
* **Be clear**: Write guides others can understand
* **Be current**: Keep content up-to-date
* **Be grateful**: Acknowledge helpful contributions

### Don'ts ❌

* **Don't be rude**: No insults, mockery, or condescension
* **Don't spam**: No excessive self-promotion
* **Don't plagiarize**: Always credit sources
* **Don't mislead**: No false information or clickbait
* **Don't harass**: No targeting individuals
* **Don't discriminate**: No bias based on identity
* **Don't derail**: Stay on topic

## Content Guidelines

### For Guides

#### Required

* **Clear title**: Describes what the guide covers
* **Working code**: Test before publishing
* **Proper formatting**: Use Markdown correctly
* **Appropriate content**: Follows NSFW/SFW modes

#### Encouraged

* **Code examples**: Show, don't just tell
* **Explanations**: Why, not just what
* **Prerequisites**: List requirements upfront
* **Expected output**: Show what success looks like
* **Common errors**: Address typical pitfalls
* **Version info**: Specify library/framework versions

#### Not Allowed

* **Plagiarism**: Copying without attribution
* **Malicious code**: Harmful or destructive examples
* **Spam**: Promotional content disguised as guides
* **Off-topic**: Unrelated to programming/development
* **Illegal content**: Copyright violations, exploits, etc.
* **Deliberately wrong**: Intentionally misleading information

### For Comments

#### Helpful Comments

```markdown theme={null}
Good: "Thanks for this! One note: in step 3, you might want to
add error handling for the edge case where the API returns null."

Good: "This helped me fix my issue! For anyone using TypeScript,
here's the type definition: [code]"

Good: "I think there's a typo in line 12 - should be
`const` not `cosnt`"
```

#### Unhelpful Comments

```markdown theme={null}
Bad: "This doesn't work"

Bad: "Just use [other library] instead"

Bad: "Why would anyone do it this way lol"
```

## Respectful Behavior

### What Respect Looks Like

* Assuming good intent
* Disagreeing without being disagreeable
* Offering constructive criticism
* Thanking people for their contributions
* Admitting when you're wrong
* Learning from others

### What Disrespect Looks Like

* Personal attacks or insults
* Dismissive or condescending language
* Gatekeeping ("real developers don't...")
* Harassment or bullying
* Hate speech or slurs
* Doxxing or threats

<Warning>
  **Zero tolerance**: Harassment, hate speech, and threats result in immediate permanent bans.
</Warning>

## Technical Standards

### Code Quality

Your code examples should:

* **Work**: Be tested and functional
* **Be secure**: No obvious security vulnerabilities
* **Be readable**: Well-formatted and clear
* **Be appropriate**: Production-ready or labeled as example-only

### Information Accuracy

* Verify facts before publishing
* Cite sources when applicable
* Specify versions and dependencies
* Note if information may become outdated
* Update guides when needed

### Intellectual Property

* **Original work**: Write your own guides
* **Proper attribution**: Credit sources and inspirations
* **Respect licenses**: Follow open source licenses
* **No plagiarism**: Don't copy without permission

## SFW vs NSFW Content

### SFW Mode (Safe for Work)

* Professional language
* No profanity
* No mature content
* Appropriate for all audiences

### NSFW Mode (Not Safe for Work)

* Casual language allowed
* Mild profanity permitted
* Still no explicit content
* Still professional in tone

<Info>
  **The line**: NSFW doesn't mean "anything goes". It means slightly more relaxed language, not inappropriate content.
</Info>

## Enforcement

### Warning System

1. **First offense**: Warning and explanation
2. **Second offense**: Temporary suspension (3-7 days)
3. **Third offense**: Longer suspension (30 days)
4. **Continued violations**: Permanent ban

### Immediate Bans

No warnings for:

* Spam bots
* Harassment or threats
* Hate speech
* Illegal content
* Malicious code
* Severe or repeated violations

### Appeals

* All actions can be appealed
* Contact support with your case
* Provide context and explanation
* Decisions reviewed within 48 hours

## Reporting Violations

See something that violates these guidelines?

1. **Don't engage**: Don't respond or escalate
2. **Report it**: Use the Report button
3. **Provide context**: Explain the violation
4. **Be patient**: Allow time for review

See [Reporting Content](/community/reporting-content) for details.

## Scope

These guidelines apply to:

* All guides and comments
* User profiles and bios
* Direct messages (coming soon)
* All public areas of the site

## Legal Requirements

In addition to these guidelines, you must:

* Follow our [Terms of Service](/legal/terms)
* Respect our [Privacy Policy](/legal/privacy)
* Comply with applicable laws
* Respect others' legal rights

## Questions?

These guidelines are living documents that evolve with our community:

* **Unclear rule?** Ask in the community
* **Edge case?** Contact support
* **Suggestion?** We welcome feedback
* **Dispute?** Use the appeal process

## Philosophy

We believe in:

* **Trust but verify**: Assume good intent, moderate when needed
* **Education over punishment**: Help people learn the rules
* **Transparency**: Clear rules, clear enforcement
* **Community-driven**: Built by developers, for developers

Thank you for being part of the RTFM.guide community! Together, we're building a resource that makes developers' lives easier, one guide at a time.

***

**Questions about these guidelines?** Contact [support@rtfm.guide](mailto:support@rtfm.guide)

**Last updated**: 2025-01-29