Contributing to Warlock-Studio

🎉 Thank you for your interest in contributing to Warlock-Studio! This project thrives with the help of developers, testers, designers, and users like you.

Ways to Contribute

There are many ways you can help:

📦 Feature Development — Add new functionalities or improve existing ones.
🐛 Bug Fixes — Squash those pesky bugs.
📝 Documentation — Improve README, usage guides, or internal comments.
🧪 Testing — Help us catch edge cases and improve stability.
💡 Ideas & Feedback — Suggest improvements or report issues.

Getting Started

1. Fork the Repository

Click the Fork button at the top right of this repo to create your own copy.

2. Clone Your Fork

git clone https://github.com/YOUR-USERNAME/Warlock-Studio.git
cd Warlock-Studio

3. Create a New Branch

Name your branch clearly and descriptively:

git checkout -b fix-ui-overflow

4. Make Your Changes

Work your magic! Make sure to follow the existing code style and structure.

5. Test Your Changes

Ensure that your changes don’t break existing functionality.

Commit Guidelines

Write clear, concise commit messages (e.g., fix: prevent UI overflow on resize).
Group related changes into a single commit when possible.
Use Conventional Commits format if you're comfortable.

Pull Requests

Push your branch:

git push origin fix-ui-overflow

Open a Pull Request against the main branch on this repo.
Include a clear description of your changes and reference any related issues (e.g., Fixes #12).
Be open to feedback! We may suggest improvements or ask for changes.

Code Style

Use consistent formatting and indentation.
Comment your code when necessary for clarity.
Avoid hardcoding paths—use relative paths and config values where possible.

Dependencies

Warlock-Studio integrates with:

MedIA-Witch
MedIA-Wizard
AI models like Real-ESRGAN, Waifu2x, Anime4K, etc.

Make sure to test your changes across common workflows.

Need Help?

Feel free to reach out by email or open a discussion if you're unsure where to start.

Thanks for making Warlock-Studio better! 🧙‍♂️✨

2.5 KiB Raw Blame History Unescape Escape