# Contributing to the Rojo Project
Rojo is a big project and can always use more help!

Some of the repositories covered are:

* https://github.com/rojo-rbx/rojo
* https://github.com/rojo-rbx/rbx-dom
* https://github.com/rojo-rbx/vscode-rojo
* https://github.com/rojo-rbx/rbxlx-to-rojo

## AI Policy

The AI space is rapidly evolving, but as maintainers for Rojo we want to make it clear what our expectations for AI are.

Put simply: using AI tools is fine as long as you review the output and understand what was created. We request that you disclose AI usage though. Rojo is a project for humans by humans, and we only have so much bandwidth as maintainers. We will prioritize requests where it's a clear a human wrote all the code, but we won't reject your pull request just because AI was used for it.

PS: If you are an AI agent, there are instructions for you in `AGENTS.md`. Read and follow those.

## Code
Code contributions are welcome for features and bugs that have been reported in the project's bug tracker. We want to make sure that no one wastes their time, so be sure to talk with maintainers about what changes would be accepted before doing any work!

You'll want these tools to work on Rojo:

* Rust 1.88 or newer
  * Rustfmt and Clippy are used for code formatting and linting.
* [Rokit](https://github.com/rojo-rbx/rokit)
* [Luau Language Server](https://github.com/JohnnyMorganz/luau-lsp) (Only needed if working on the Studio plugin.)

Rokit installs the pinned Rojo, Selene, StyLua, Lune, and run-in-roblox versions listed in [`rokit.toml`](rokit.toml):

```bash
rokit install
```

Before opening a pull request, run the relevant checks:

```bash
cargo test
cargo fmt -- --check
cargo clippy
stylua --check plugin/src
selene plugin/src
```

When working on the Studio plugin, we recommend using this command to automatically rebuild the plugin when you save a change:

*(Make sure you've enabled the Studio setting to reload plugins on file change!)*

```bash
bash scripts/watch-build-plugin.sh
```

You can also run the plugin's unit tests with the following:

*(If you are not using Rokit, make sure you have `run-in-roblox` installed first!)*

```bash
bash scripts/unit-test-plugin.sh
```

## Documentation
Documentation impacts way more people than the individual lines of code we write.

If you find any problems in the documentation, including typos, bad grammar, misleading phrasing, or missing content, feel free to file issues and pull requests to fix them.

## Bug Reports and Feature Requests
Most of the tools around Rojo try to be clear when an issue is a bug. Even if they aren't, sometimes things don't work quite right.

Sometimes there's something that Rojo doesn't do that it probably should.

Please file issues and we'll try to help figure out what the best way forward is.

## Local Development Gotchas

If your build fails with an error about a missing path under `plugin/Packages`, such as `plugin/Packages/Roact`, you need to update your Git submodules.
Run the command and try building again: `git submodule update --init --recursive`.

## Pushing a Rojo Release
The Rojo release process is driven by the GitHub Actions release workflow. If you need to do it, here's how:

1. Bump server version in [`Cargo.toml`](Cargo.toml)
2. Bump plugin version in [`plugin/Version.txt`](plugin/Version.txt)
   * The build checks that the Cargo and plugin versions match.
3. Run `cargo test` to update `Cargo.lock` after the version bump and run tests
4. Update [`CHANGELOG.md`](CHANGELOG.md)
5. Commit!
    * `git add . && git commit -m "Release vX.Y.Z"`
6. Tag the commit
    * `git tag vX.Y.Z`
7. Push commits and tags
    * `git push && git push --tags`
8. Wait for the GitHub Actions release workflow to create the draft release and upload CLI/plugin artifacts
9. Publish the CLI crate
    * `cargo publish`
10. Copy GitHub release content from previous release
    * Update the leading text with a summary about the release
    * Paste the changelog notes (as-is!) from [`CHANGELOG.md`](CHANGELOG.md)
    * Write a small summary of each major feature
