Contributing

Contributing Guide

Thank you for your interest in the SuperEZ project! We welcome contributions of all kinds.

How to Contribute

Reporting Issues

If you find a bug or have a suggestion for a new feature, please create a new issue in the issue tracker. When submitting an issue, please provide as much information as possible:

• Clear description of the issue
• Steps to reproduce
• Expected behavior vs. actual behavior
• Relevant logs or screenshots
• System environment information

Submitting Code

1. Fork the project repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Create a Pull Request

Code Style

• Follow the existing code style in the project
• Ensure all tests pass
• Add tests for new features
• Update relevant documentation

Development Environment Setup

# Clone the repository
git clone https://github.com/EZ-HKU/SuperEZ.git

# Install dependencies
cd SuperEZ
npm install

# Run development server
npm run dev

Commit Guidelines

We use Conventional Commits specification. Each commit message should include a type and description:

<type>[optional scope]: <description>

[optional body]

[optional footer]

Common types include:

• feat: New feature
• fix: Bug fix
• docs: Documentation change
• style: Changes that do not affect code meaning (whitespace, formatting, missing semi-colons, etc)
• refactor: Code change that neither fixes a bug nor adds a feature
• test: Adding or correcting tests
• chore: Changes to build process or auxiliary tools

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.