Thank you for taking the time to contribute to this project! My goal with this project is to help Lua scripters through:
- Providing code that is documented, optimized, and readable.
- Providing code that contains error-handling and easily understood error states.
- Providing resources that speed up mod development.
Before you begin, please note that all files in this repository are licensed under the MIT License; this will also include your work. See LICENSE for details.
If you need to contact me you can contact me through Discord at galactic_2005.
It's recommended to work in the experimental branch so that previous features are left untouched and that code behavior will stay the same for the end-user until they decide to update.
You can clone the experimental branch through the following git command:
git clone -b experimental https://github.com/galactic2005/PEModUtils.git
Remember to also perform Pull Requests to the experimental branch as well!
To keep code maintainable, optimized, and readable, a style guide is enforced. See LUASTYLEGUIDE for details.
To keep documentation clean and usable, a style guide is enforced. See DOCSTYLEGUIDE for details.
Make sure all Pull Requests go into the Experimental branch.