From 01dcf05cae087348796b19f70686987ae489441e Mon Sep 17 00:00:00 2001 From: Erica Marigold Date: Thu, 13 Feb 2025 16:27:56 +0000 Subject: [PATCH] chore(README): add contributing section --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 75693dc..e766b42 100644 --- a/README.md +++ b/README.md @@ -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.