Contributing Guide

How to Contribute

Contribution Methods

• Code Contribution - Submit Pull Request
• Issue Reporting - Submit Issue
• Feature Suggestions - Discuss in Issues
• Documentation Improvements - Fix typos, add explanations

Basic Requirements

• Be civilized and friendly, respect each other
• Please provide screenshots or screen recordings for issue reports
• Please test functionality before submitting code
• Follow the project's existing code style

Commit Standards

Commit Message Format

type(scope): short description

detailed description (optional)

Commit Types

• feat: New feature
• fix: Bug fix
• docs: Documentation updates
• style: Code formatting adjustments
• refactor: Code refactoring
• test: Testing related
• chore: Build tools or auxiliary tool changes

Examples

feat(note): Add note search functionality
fix(ui): Fix mobile display issues
docs: Update installation instructions

Issue Reporting

Reporting Requirements

• Must include screenshots or screen recordings - Help quickly locate issues
• Detailed description of the problem
• Provide reproduction steps
• Specify operating system and browser version

Report Template

## Issue Description

[Detailed description of the issue]

## Reproduction Steps

1. Step 1
2. Step 2
3. Step 3

## Screenshots/Screen Recording

[Please upload screenshots or screen recording files]

## Environment Information

- Operating System:
- Browser:
- Project Version:

Code Contribution

Development Process

1. Fork the project
2. Create feature branch: git checkout -b feature/your-feature
3. Commit code: git commit -m "feat: your feature"
4. Push branch: git push origin feature/your-feature
5. Submit Pull Request

Code Requirements

• Keep code concise and clear
• Add necessary comments
• Ensure functionality works properly
• Follow TypeScript standards

Community Standards

Code of Conduct

• Maintain friendliness and respect
• Encourage constructive discussion
• Avoid personal attacks
• Help new contributors

Communication Methods

• Use Chinese or English
• Issue discussions in GitHub Issues
• Technical exchanges in Discussions
• Maintain patience and understanding

Thanks

Thank you to all friends who have contributed to the project! Every contribution, no matter how small, makes the project better.

---

Remember: This is a small project, simplicity and directness are most important!