Skip to content

Commit

Permalink
Remove mentions of luacheck, update to match roact-rodux.
Browse files Browse the repository at this point in the history
  • Loading branch information
matthargett committed Nov 2, 2021
1 parent cc70f8a commit 467dc9c
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ To get started working on Rodux, you'll need:
* Git
* Lua 5.1
* [LuaFileSystem](https://keplerproject.github.io/luafilesystem/) (`luarocks install luafilesystem`)
* [Luacheck](https://github.com/mpeterv/luacheck) (`luarocks install luacheck`)
* [LuaCov](https://keplerproject.github.io/luacov) (`luarocks install luacov`)
* [Foreman](https://github.com/Roblox/foreman) ([installation instructions](https://github.com/Roblox/foreman#installation))
* [Selene](https://github.com/Kampfkarren/selene) (`foreman install`, or download latest release into your `PATH`)
* [StyLua](https://github.com/JohnnyMorganz/StyLua) (`foreman install` -- you only need to run foreman once -- or download latest release into your `PATH`)

Before the tests will work, make sure you have all of the repository's Git submodules installed. If you haven't cloned it yet, you can use:

Expand All @@ -28,14 +30,13 @@ git clone --recurse-submodules https://github.com/Roblox/rodux.git
If you've already cloned the Rodux repository, you can use:

```sh
git submodule init
git submodule update
git submodule update --init
```

Finally, you can run all of Rodux's tests with:

```sh
lua spec.lua
lua test/lemur.lua
```

Or, to generate a LuaCov coverage report:
Expand All @@ -49,10 +50,11 @@ luacov
Before starting a pull request, open an issue about the feature or bug. This helps us prevent duplicated and wasted effort. These issues are a great place to ask for help if you run into problems!

Before you submit a new pull request, check:
* Code Style: Match the existing code!
* Changelog: Add an entry to [CHANGELOG.md](CHANGELOG.md)
* Luacheck: Run [Luacheck](https://github.com/mpeterv/luacheck) on your code, no warnings allowed!
* Code Quality: Run [Selene](https://github.com/Kampfkarren/selene) on your code, no warnings allowed!
* Code Style: Run [StyLua](https://github.com/JohnnyMorganz/StyLua) on your code so it's formatted to follow the Roblox Lua Style Guide
* Tests: They all need to pass!
* Coverage: Code coverage of tests should not decrease.

### Code Style
Try to match the existing code style! In short:
Expand All @@ -61,19 +63,13 @@ Try to match the existing code style! In short:
* Double quotes
* One statement per line

Eventually we'll have a tool to check these things automatically.
Use StyLua to automatically format your code to comply with the Roblox Lua Style Guide.
You can run this tool manually from the commandline (`stylua -c src/`), or use one of StyLua's editor integrations.

### Changelog
Adding an entry to [CHANGELOG.md](CHANGELOG.md) alongside your commit makes it easier for everyone to keep track of what's been changed.

Add a line under the "Current master" heading. When we make a new release, all of those bullet points will be attached to a new version and the "Current master" section will become empty again.

### Luacheck
We use [Luacheck](https://github.com/mpeterv/luacheck) for static analysis of Lua on all of our projects.

From the command line, just run `luacheck src` to check the Rodux source.

You should get it working on your system, and then get a plugin for the editor you use. There are plugins available for most popular editors!
Add a line under the "Unreleased Changes" heading. When we make a new release, all of those bullet points will be attached to a new version and the "Unreleased Changes" section will become empty again.

### Tests
When submitting a bug fix, create a test that verifies the broken behavior and that the bug fix works. This helps us avoid regressions!
Expand Down

0 comments on commit 467dc9c

Please sign in to comment.