Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (51 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

72 lines (51 loc) · 2.93 KB
Raw

Contributing to FastCast2

Thank you for considering contributing to FastCast2!
This project is open-source and community-driven, and all kinds of help are welcome, code or documentation, bug reports, examples, ideas, or even just spreading the word.

How to Contribute

  1. Found a bug? Have an idea?

    • Open an Issue first (bug report, feature request, question, etc.)
    • Use a clear title and describe the problem/suggestion in detail

  2. Want to submit code or docs?

    • Fork the repository
    • Create a new branch for your work
      git checkout -b fix/something or git checkout -b feature/new-cool-things
    • Make your changes
    • Commit your changes
    • Push to your fork
    • Open a Pull Request against the main branch
    • You must provide RBXM file to the author for release (Optional)

    (Only if the author aka Mawin_CK himself requested you to provide RBXM for the release)

All pull requests will go through code review before merging.

Code Review Expectations

  • Code should be clean, readable, and follow existing style (Luau typing, naming conventions, etc.)
  • Code should pass Basic testing
  • Documentation should be updated if the public API changes
  • Keep PRs focused - one feature/fix per pull request is ideal
  • Be prepared to make changes based on feedback

Commit Message Guidelines

Examples:

  • fix: prevent nil reference in ObjectCache
  • feat: add BulkMoveTo support for parts.
  • docs: improve usage example for parallel mode.
  • chore: update Luau types in Caster.

(It's recommended to follow this Instruction guideline, but you can make lazy commits if you want, because even the main developer still does that)

Changelog Policy

I'm not strict about changelogs, and I don't really bother writing explicit changelogs, but:

  • If you make any changes, modifications, or fixes to something, at least let me know.
  • I'll mostly use the DevForum to tell you guys about any changes or fixes.

Communication

Rules

  • Be respectful — to everyone (maintainers, other contributors, users)
  • No personal attacks, harassment, or toxic behavior
  • Keep discussions technical and constructive

Testing

Questions?

Feel free to ask anything:

Thanks again for helping make FastCast2 better!

Mawin CK - 2025