CONTRIBUTING.md•1.66 kB
# Contributing to @boomlinkai/image-worker-mcp
First off, thank you for considering contributing to @boomlinkai/image-worker-mcp! It's people like you that make open source such a great community.
## Where do I go from here?
If you've noticed a bug or have a question, [search the issue tracker](https://github.com/BoomLinkAi/image-worker-mcp/issues) to see if someone else has already reported the issue. If not, feel free to open a new issue.
## Fork & create a branch
If you want to contribute with code, please fork the repository and create a new branch from `main` (or your default branch). A good branch name would be (e.g. `fix/my-bug-fix` or `feat/new-feature`).
## Code Style
Please ensure your code adheres to the existing style. This project uses ESLint and Prettier for code linting and formatting. You can run `pnpm lint` to check your code.
## Commit Messages
This project uses [Conventional Commits](https://www.conventionalcommits.org/). Please follow this format for your commit messages. You can use `pnpm commit` to help you create a compliant commit message.
## Submitting a Pull Request
When you're ready to submit your contribution, create a Pull Request against the `main` branch of the original repository.
- Ensure your PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
- Make sure all tests pass (`pnpm test`).
- Make sure your code lints (`pnpm lint`).
- Make sure your code is type-checked (`pnpm typecheck`).
## Getting Help
If you have questions or need help with your contribution, feel free to ask in an issue or discussion.
Thank you for your contribution!