Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.46 KB

File metadata and controls

55 lines (38 loc) · 1.46 KB

Contributing

Thanks for your interest in contributing to Roblox Dev Toolkit.

Contributions, bug reports, documentation improvements, and feature ideas are welcome.

How to Contribute

  1. Fork the repository.
  2. Create a branch for your change.
  3. Make your changes.
  4. Test your changes in Roblox Studio when applicable.
  5. Update documentation when necessary.
  6. Open a pull request describing your changes.

Guidelines

  • Write clear, readable Luau code.
  • Keep modules focused on a specific purpose.
  • Prefer reusable solutions over game-specific implementations.
  • Avoid unnecessary dependencies.
  • Follow the existing project structure.
  • Add or update tests when changing behavior.
  • Update documentation when adding or changing public APIs.
  • Keep pull requests focused on one change when possible.

Bug Reports

When reporting a bug, include:

  • What happened
  • What you expected to happen
  • Steps to reproduce the issue
  • Relevant code or error messages
  • Roblox Studio or Luau version when relevant

Feature Requests

Before requesting a feature, explain:

  • The problem the feature would solve
  • Why it would be useful to other Roblox developers
  • A simple example of how the feature could be used

Pull Requests

Pull requests should:

  • Clearly describe the change.
  • Include relevant tests when applicable.
  • Keep unrelated changes out of the pull request.
  • Ensure the project still builds successfully with Rojo.

Thank you for helping improve Roblox Dev Toolkit.