This repository has been archived by the owner on Sep 14, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
86 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# TestEZ Changelog | ||
|
||
## Current master | ||
* No changes | ||
|
||
## 1.0.0 (TODO: Date) | ||
* Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,72 @@ | ||
# Contributing to TestEZ | ||
TODO | ||
Thanks for considering contributing to TestEZ! This guide has a few tips and guidelines to make contributing to the project as easy as possible. | ||
|
||
## Bug Reports | ||
Any bugs (or things that look like bugs) can be reported on the [GitHub issue tracker](https://github.com/Roblox/TestEZ/issues). | ||
|
||
Make sure you check to see if someone has already reported your bug first! Don't fret about it; if we notice a duplicate we'll send you a link to the right issue! | ||
|
||
## Feature Requests | ||
If there are any features you think are missing from TestEZ, you can post a request in the [GitHub issue tracker](https://github.com/Roblox/TestEZ/issues). | ||
|
||
Just like bug reports, take a peak at the issue tracker for duplicates before opening a new feature request. | ||
|
||
## Working on TestEZ | ||
To get started working on TestEZ, 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`) | ||
|
||
Once you have all of these installed, you can run the `install-dependencies` script to grab a couple additional local dependencies automatically. | ||
|
||
Finally, you can run all of TestEZ's tests with: | ||
|
||
```sh | ||
lua spec.lua | ||
``` | ||
|
||
Or, to generate a LuaCov coverage report: | ||
|
||
```sh | ||
lua -lluacov spec.lua | ||
luacov | ||
``` | ||
|
||
## Pull Requests | ||
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! | ||
* Tests: They all need to pass! | ||
|
||
### Code Style | ||
Try to match the existing code style! In short: | ||
|
||
* Tabs for indentation | ||
* Double quotes | ||
* One statement per line | ||
|
||
Eventually we'll have a tool to check these things automatically. | ||
|
||
### 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 lib` to check the TestEZ 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! | ||
|
||
### 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! | ||
|
||
When submitting a new feature, add tests for all functionality. | ||
|
||
We use [LuaCov](https://keplerproject.github.io/luacov) for keeping track of code coverage. We'd like it to be as close to 100% as possible, but it's not always easy. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters