Contributing to Wox

Thank you for your interest in contributing to Wox! This document provides guidelines and instructions for contributing to the project.

Getting Started

1. Fork the Repository: Start by forking the Wox repository on GitHub.

2. Clone Your Fork: Clone your fork to your local machine.

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

3. Set Up Development Environment: Follow the instructions in the Development Setup document to set up your development environment.

   make dev

Development Workflow

Branching Strategy

• master: The main branch that contains the latest stable code
• feature/*: Feature branches for new features
• bugfix/*: Bugfix branches for bug fixes

Making Changes

1. Create a Branch: Create a new branch for your changes.

   git checkout -b feature/your-feature-name

2. Make Your Changes: Implement your changes, following the coding standards and guidelines.

3. Test Your Changes: Run tests to ensure your changes don't break existing functionality.

   make test

4. Commit Your Changes: Commit your changes with a clear and descriptive commit message.

   git commit -m "feat: add new feature"

   Please follow the Conventional Commits specification for your commit messages:

   • feat: A new feature
   • fix: A bug fix
   • docs: Documentation only changes
   • style: Changes that do not affect the meaning of the code
   • refactor: A code change that neither fixes a bug nor adds a feature
   • perf: A code change that improves performance
   • test: Adding missing tests or correcting existing tests
   • chore: Changes to the build process or auxiliary tools

5. Push Your Changes: Push your changes to your fork.

   git push origin feature/your-feature-name

6. Create a Pull Request: Create a pull request from your branch to the main Wox repository.

Pull Request Guidelines

When creating a pull request, please:

1. Provide a Clear Description: Describe what your changes do and why they should be included.
2. Reference Related Issues: If your PR fixes an issue, reference it using the GitHub issue number.
3. Include Tests: If your changes include new functionality, include tests that cover the new code.
4. Update Documentation: If your changes require documentation updates, include those in your PR.

Code Style Guidelines

Go Code

• Follow the Go Code Review Comments
• Use gofmt to format your code
• Write meaningful comments and documentation

Flutter/Dart Code

• Follow the Dart Style Guide
• Use dart format to format your code
• Write meaningful comments and documentation

JavaScript/TypeScript Code

• Follow the Airbnb JavaScript Style Guide
• Use ESLint to lint your code
• Write meaningful comments and documentation

Python Code

• Follow PEP 8
• Use black to format your code
• Write meaningful comments and documentation

Testing

• Write unit tests for your code
• Run existing tests to ensure your changes don't break existing functionality
• Consider adding integration tests for complex features

Documentation

• Update documentation for any changes to existing features
• Add documentation for new features
• Use clear and concise language

Community

• Join the Wox Discussions to ask questions and get help
• Be respectful and considerate of others

Reporting Issues

If you find a bug or have a feature request, please:

1. Check if the issue already exists in the GitHub Issues
2. If not, create a new issue with a clear description and steps to reproduce

License

By contributing to Wox, you agree that your contributions will be licensed under the project's license.