lm-studio-tools
Public
Forked from beledarian/beledarians-lm-studio-tools
Forked from beledarian/beledarians-lm-studio-tools
Project Files
CONTRIBUTING.md
First off, thank you for considering contributing to this project! It's people like you that make the open-source community such an amazing place to learn, inspire, and create.
If you find a bug, please create an Issue on GitHub. Include:
If you want to contribute to the development of this plugin, you can follow these steps:
Clone the repository:
Install dependencies:
Run in development mode: From within the project directory, run the following command:
This will start the plugin in development mode. LM Studio should automatically pick it up. Any changes you make to the source code will cause the plugin to automatically reload.
To keep the history clean and ensure quality, please follow this workflow:
Since this project uses TypeScript, please adhere to the following:
any whenever possible. Define interfaces/types for your data structures.Open an issue or start a discussion. I'm happy to help!
By contributing to this project you agree that any of your contributions will be licensed under the MIT License. This is the same license as the project itself.
Any contribution submitted for inclusion in this project by you shall be licensed as above, without any additional terms or conditions.
Thank you for your contributions!
Create a Branch: Never work directly on main. Create a descriptive branch for your feature or fix:
Make your changes: Write your code and ensure it follows the project's style.
Commit your changes: Use clear, descriptive commit messages.
Run full testsuite and add tests:
Ensure all exsisting test pass and you add regression/ feature tests for the feature/ tools you added.
Push to your fork:
Open a Pull Request: Go to the original repository and click "Compare & pull request." Provide a clear description of what you changed and why.
git clone [https://github.com/your-username/Beledarians_LM_Studio_Toolbox.git](https://github.com/your-username/Beledarians_LM_Studio_Toolbox.git)
cd Beledarians_LM_Studio_Toolbox
npm install
git clone https://github.com/Beledarian/Beledarians_LM_Studio_Toolbox.git
cd Beledarians_LM_Studio_Toolbox
npm install
lms dev
git checkout -b feature/amazing-new-tool
# or
git checkout -b fix/annoying-bug
git commit -m "feat: add token counter utility"
npm test
git push origin feature/amazing-new-tool