|
| 1 | +# Contributing to Windows Event Automation Engine |
| 2 | + |
| 3 | +Thank you for your interest in contributing! This document will help you get started. |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +1. **Fork the repository** on GitHub |
| 8 | +2. **Clone your fork**: |
| 9 | + ```bash |
| 10 | + git clone https://github.com/yourusername/win_event_engine.git |
| 11 | + cd win_event_engine |
| 12 | + ``` |
| 13 | +3. **Install prerequisites**: |
| 14 | + - [Rust](https://rustup.rs/) (latest stable) |
| 15 | + - [Visual Studio Build Tools](https://visualstudio.microsoft.com/downloads/) (Windows only) |
| 16 | + |
| 17 | +## Development Setup |
| 18 | + |
| 19 | +```bash |
| 20 | +# Build the project |
| 21 | +cargo build --release |
| 22 | + |
| 23 | +# Run tests |
| 24 | +cargo test |
| 25 | + |
| 26 | +# Run with example config |
| 27 | +cargo run --release -- -c config.toml.example |
| 28 | +``` |
| 29 | + |
| 30 | +## Code Style |
| 31 | + |
| 32 | +- Follow standard Rust formatting (`cargo fmt`) |
| 33 | +- Run clippy before committing (`cargo clippy`) |
| 34 | +- Keep functions focused and documented |
| 35 | +- Use meaningful variable names |
| 36 | + |
| 37 | +## Testing |
| 38 | + |
| 39 | +```bash |
| 40 | +# Run all tests |
| 41 | +cargo test |
| 42 | + |
| 43 | +# Run specific crate tests |
| 44 | +cargo test -p engine |
| 45 | +cargo test -p actions |
| 46 | + |
| 47 | +# Run with output |
| 48 | +cargo test -- --nocapture |
| 49 | +``` |
| 50 | + |
| 51 | +## Submitting Changes |
| 52 | + |
| 53 | +1. **Create a branch** for your feature/fix: |
| 54 | + ```bash |
| 55 | + git checkout -b feature/my-feature |
| 56 | + ``` |
| 57 | + |
| 58 | +2. **Make your changes** and test them |
| 59 | + |
| 60 | +3. **Commit with clear messages**: |
| 61 | + ```bash |
| 62 | + git commit -m "Add feature X to do Y" |
| 63 | + ``` |
| 64 | + |
| 65 | +4. **Push to your fork**: |
| 66 | + ```bash |
| 67 | + git push origin feature/my-feature |
| 68 | + ``` |
| 69 | + |
| 70 | +5. **Open a Pull Request** on GitHub with: |
| 71 | + - Clear description of changes |
| 72 | + - Why the change is needed |
| 73 | + - Testing performed |
| 74 | + |
| 75 | +## Areas for Contribution |
| 76 | + |
| 77 | +- Bug fixes |
| 78 | +- New event source plugins |
| 79 | +- New action types |
| 80 | +- Documentation improvements |
| 81 | +- Lua API enhancements |
| 82 | +- Performance optimizations |
| 83 | + |
| 84 | +## Questions? |
| 85 | + |
| 86 | +- Open an issue for bugs or feature requests |
| 87 | +- Check existing issues and PRs first |
| 88 | +- Join discussions in open issues |
| 89 | + |
| 90 | +## License |
| 91 | + |
| 92 | +By contributing, you agree that your contributions will be licensed under the MIT License. |
0 commit comments