Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ modules/
resources-react/ # React hook for resources
```

Please only make modifications in the directories above. If you want to add or modify any of the repo tooling or packages (e.g. updating foreman.toml or wally.toml), please open an issue and reach out to the maintainers for assistance.
Please only make modifications in the directories above. You may notice there are duplicate config files for some of our tooling (e.g. foreman.toml vs foreman-internal.toml, rotriever.toml vs wally.toml, default.project.json vs default.rbxp) as well as some internal specific files (e.g. .lestrc). Repo maintainers use these internal specific files to run the same tests on different tooling. If you want to add or modify any of the repo tooling or packages (e.g. updating foreman.toml or wally.toml), please open an issue and reach out to the maintainers for assistance.

## Code Guidelines

Expand Down Expand Up @@ -63,6 +63,20 @@ rocale-cli run \
--verbose
```

## Setting up a Fork

1. Create a fork of the repository using the Github UI
2. Generate an API key for OCALE (skip if you already have this)
- Create a new experience
- Go to your newly created experience, click on Places and get your universe and place ID
- Navigate to the API Keys tab
- Create a new API key with write access to your experience for `luau-execution-sessions` and `universe-places`
5. On your fork, add these secrets
- `ROBLOX_API_KEY`
- `TEST_PLACE_ID`
- `TEST_UNIVERSE_ID`

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to explain why these secrets need to be added / what the end goal is?


## Pull Request Guidelines

When submitting a pull request:
Expand Down
Loading