Contributing¶

Thank you for your interest in contributing to Image Editor!

Code of Conduct¶

Please read and follow our code of conduct to ensure a welcoming environment for all contributors.

How to Contribute¶

Reporting Bugs¶

Check existing issues first
Use the bug report template
Include reproduction steps
Add screenshots if applicable

Suggesting Features¶

Check existing feature requests
Use the feature request template
Describe the use case clearly

Submitting Code¶

Fork the repository
Create a feature branch
Make your changes
Write/update tests
Submit a pull request

Development Workflow¶

1. Create a Branch¶

git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

2. Make Changes¶

Follow the existing code style
Add tests for new functionality
Update documentation as needed

3. Test Your Changes¶

# Run all checks
npm run lint
npm run type-check
npm run test
npm run build

4. Commit Your Changes¶

Write clear, descriptive commit messages:

git commit -m "feat: add layer opacity slider"
git commit -m "fix: correct canvas zoom calculation"
git commit -m "docs: update installation instructions"

Follow Conventional Commits format:

feat: - New feature
fix: - Bug fix
docs: - Documentation changes
style: - Code style changes (formatting)
refactor: - Code refactoring
test: - Adding or updating tests
chore: - Maintenance tasks

5. Push and Create PR¶

git push origin feature/your-feature-name

Then create a pull request on GitHub.

Pull Request Guidelines¶

Before Submitting¶

[ ] All tests pass
[ ] Code follows project style
[ ] Documentation updated
[ ] Commit messages are clear

PR Description¶

Include:

Summary of changes
Related issue numbers
Screenshots for UI changes
Test plan

Review Process¶

Automated checks run
Maintainer reviews code
Address feedback
Merge when approved

Getting Help¶

Open a discussion
Ask questions in issues
Read the documentation

Thank you for contributing!