# Contributing to CrossMacro

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to CrossMacro. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

## 🐛 Reporting Bugs

This section guides you through submitting a bug report for CrossMacro.

- **Use the Bug Report template**: When you open a new issue, select "Bug Report".
- **Provide specific details**: Include your platform (Windows, macOS, Linux X11, or Wayland compositor), OS version, and steps to reproduce.
- **Include logs**: Logs help us diagnose issues quickly. Please include both UI and daemon logs if possible:

  **UI logs:** Run the application from terminal to see output directly.

  **Daemon logs (Linux):** Enable debug logging and capture the output:
  ```bash
  sudo systemctl kill -s USR1 crossmacro
  journalctl -u crossmacro -f
  ```
  Send the signal again to switch back to normal logging.

## 💡 Suggesting Enhancements

- **Use the Feature Request template**: Select "Feature Request" when opening an issue.
- **Explain the 'Why'**: Describe the problem you are trying to solve.

## 💻 Development Setup

### Prerequisites
- .NET 10 SDK

### Linux Setup

1. **Install system dependencies**:
   - `polkit` (required for daemon authorization)
   - `libevdev` development headers (if building from source)

2. **Install the daemon**:
   ```bash
   sudo ./scripts/daemon/install.sh
   ```
   This will:
   - Build and install the daemon to `/opt/crossmacro/daemon`
   - Create the `crossmacro` system user and group
   - Set up the systemd service
   - Add your user to the `crossmacro` group

3. **Reboot your system** for group changes to take effect.

4. **Build and run the UI**:
   ```bash
   dotnet build
   dotnet run --project src/CrossMacro.UI.Linux/
   ```

### Windows Setup

1. **Build and run**:
   ```bash
   dotnet build
   dotnet run --project src/CrossMacro.UI.Windows/
   ```
   
   No additional setup required - Windows uses API hooks directly.

### macOS Setup

1. **Build and run**:
   ```bash
   dotnet build
   dotnet run --project src/CrossMacro.UI.MacOS/
   ```

   **Permissions**: You will be prompted to grant Accessibility permissions on the first run. This is required for CGEvent Taps to function.


## 📥 Pull Requests

1. Fork the repo and create your branch from `main`.
2. Make sure your code follows the existing coding style.
3. Test your changes manually before submitting.
4. Open a Pull Request!

### PR Checks
We have a GitHub Action that automatically builds your PR. Make sure this check passes.