0x5eal/luau-unzip
1
1
Fork 0
mirror of https://github.com/0x5eal/luau-unzip.git synced 2025-04-04 06:30:53 +01:00
Code Issues Projects Releases Packages Wiki Activity

chore(README): add contributing section

Browse source
This commit is contained in:
Erica Marigold 2025-02-13 16:27:56 +00:00
parent b90e15a8f0
commit 01dcf05cae
Signed by: DevComp
SSH key fingerprint: SHA256:jD3oMT4WL3WHPJQbrjC3l5feNCnkv7ndW8nYaHX5wFw
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -52,6 +52,12 @@ print("Total size:", stats.totalSize, "bytes")
## MSLV (Minimum Supported Luau Version)
This library requires at least Luau [0.629](https://github.com/luau-lang/luau/releases/tag/0.629) (specifically requires leading `|`, `buffer` built-in and `idiv` operator support).
## Contributing
Contributions are heavily welcomed! We use Nix Flakes for management a reproducible development environment. To get started, run `exec nix develop`, after [installing Nix](https://nixos.wiki/wiki/Nix_Installation_Guide). This is recommended for tests to be consistent, since we rely on `InfoZIP` implementations as sanity checks, although different distributions supply differently patched versions of it.
- We utilize [pesde](https://pesde.dev) for package management. Run `pesde install` to install all dependencies.
- Before submitting a pull request, make sure you include comprehensive test cases for new features, and make sure all tests pass. Tests can be run with `lune run tests`. Refer to other test suites for examples of how to write your own tests.
## License
This project is licensed under the [MIT] license.