aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGravatar BanceDev 2024-09-12 09:21:12 -0400
committerGravatar BanceDev 2024-09-12 09:21:12 -0400
commitd25fc21dfccf2b8968871000c1d989dcb12c1713 (patch)
treebb05991419d514151cec9bfa0453b98a455f563a /CONTRIBUTING.md
parentadded e2e testing to cover basic shell functionality (diff)
updated documentation
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 26d24d3..34f625b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -48,6 +48,7 @@ When opening a pull request ensure that your PR is limited in scope to a singula
- A detailed description of what your changes include
- If a new function is added to the Lua API also include demo code in the example.lua file showing its use
- If you can, attach a screenshot demonstrating your change
+- Please run your code through the e2e testing in the test folder. Simply cd into tests in the shell and execute run_tests.lua
PR's will be reviewed by one of the maintainers. If they request changes, please make them or the PR will not be able to be accepted.