Thank you for your interest in contributing to this project! Here are the guidelines to help you get started.
-
Fork the Repository: Fork the repository on GitHub and clone your fork locally:
git clone https://github.com/your-username/stream-deck-ai-limits.git cd stream-deck-ai-limits -
Install Dependencies: Make sure you have Node.js v20+ installed. Then run:
npm install
-
Run Development Watch Mode: To build and watch the codebase for changes while testing the plugin in the Stream Deck app:
npm run watch
- Style: Follow the existing project structure and styling.
- Modularity: Keep actions decoupled and delegate domain logic to the
@lenadweb/ai-limitspackage. - Cleanliness: Write clean, readable, self-documenting code.
- Linting: Ensure your editor settings respect the formatting configurations.
Please write your commit messages in the project's established style:
- Use lowercase for the first letter of the message.
- Start with a direct, present or past tense verb (e.g.,
add,update,remove,fix,improve). - Do not use prefixes like
feat:,fix:, orchore:. - Be concise and descriptive.
Example:
add settings option for minimax api key
- Create a new branch for your feature or fix:
git checkout -b your-feature-branch
- Make your modifications, verify that the project builds successfully (
npm run build). - Commit your changes following the commit guidelines.
- Push your branch to your fork and submit a Pull Request to the
mainbranch.