Skip to Content
Contributing

Contributing to FiveM Docs

Thank you for contributing to FiveM Docs! This document provides guidelines for contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork
  3. Install dependencies: pnpm install
  4. Create a branch: git checkout -b my-feature
  5. Make your changes
  6. Test locally: pnpm dev
  7. Commit your changes
  8. Push to your fork
  9. Open a Pull Request

Writing Guidelines

Page Structure

Every page should include:

  • Title: Clear, task-oriented title
  • Description: Brief description in frontmatter
  • Prerequisites: What’s needed before starting
  • Steps: Clear, numbered steps
  • Validation: How to verify success
  • Rollback: How to undo changes
  • Links: Related pages (minimum 3)

Code Blocks

  • All code blocks must have copy buttons (automatic with Nextra)
  • Include expected output where relevant
  • Use appropriate language tags
  • Test all commands on clean systems

OS-Aware Content

Use the OsPicker component for OS-specific instructions:

<OsPicker>
  <OsPicker.Linux>Linux-specific content</OsPicker.Linux>
  <OsPicker.Windows>Windows-specific content</OsPicker.Windows>
</OsPicker>

Code Quality

  • Run pnpm type-check before committing
  • Run pnpm lint and fix any issues
  • Run pnpm build to verify build succeeds
  • All files must be under 300 LOC

Pull Request Process

  1. Update documentation if needed
  2. Add tests if applicable
  3. Ensure all checks pass
  4. Request review from maintainers
  5. Address feedback
  6. Merge after approval

Questions?

Open an issue or contact maintainers.