Contributing
Welcome to Lagless.gg Contribution guide!
Simple Way to Contribute
- Fork the repository
- Clone your fork:
git clone https://github.com/YOUR-USERNAME/lagdocs.git - Create a new branch:
git checkout -b docs/your-change - Edit or add documentation files using our existing format
- Commit your changes and push them to your fork
- Open a pull request with a brief description
That’s it! Our team will review your changes and provide feedback if needed. We welcome community contributions to help improve our documentation.
Our Guidelines
Standards
- Follow the existing MDX structure and file layout
- Keep content clear, concise, and neutral
- Use proper headings and do not skip heading levels
- Always include language tags for code blocks
- Include alt text for all images
- Use callouts only when necessary
Writing Style
- Use active voice
- Keep sentences concise
- Break up long paragraphs
- Use consistent terminology
- Include examples for complex concepts
- Ensure all links work
- Check spelling and grammar
Pull Requests
- Update your fork to the latest upstream changes
- Run tests locally and ensure everything builds
- Fill out the pull request template completely
- Include screenshots for visual changes when applicable
- Link to related issues and add labels as appropriate
- Respond to reviewer feedback promptly
- Make requested changes in new commits
- Squash commits before final merge
All contributions are reviewed before merging and must meet our documentation quality standards.