diff options
| author |  BanceDev
| 2024-09-12 09:21:12 -0400 |
|---|---|---|
| committer | BanceDev
| 2024-09-12 09:21:12 -0400 |
| commit | d25fc21dfccf2b8968871000c1d989dcb12c1713 (patch) | |
| tree | bb05991419d514151cec9bfa0453b98a455f563a | |
| parent | added e2e testing to cover basic shell functionality (diff) | |
updated documentation
| -rw-r--r-- | CONTRIBUTING.md | 1 | ||||
| -rw-r--r-- | README.md | 13 |
2 files changed, 14 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. @@ -58,3 +58,16 @@ Using the Lunar Shell API to make your own scripts is super simple. Upon install - If you wish to contribute code of your own please submit a [pull request](https://github.com/BanceDev/lush/pulls). - Note: It is likely best to submit an issue before a PR to see if the feature is wanted before spending time making a commit. - All help is welcome! + +## License + +This project is licensed under the BSD 3-Clause License. + +The BSD 3-Clause License allows for redistribution and use in source and binary forms, with or without modification, provided the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution. +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +For more details, see the [LICENSE](./LICENSE) file. + |