From 66097f2c1bc6f90139aa16199e532563fefd762a Mon Sep 17 00:00:00 2001 From: SKYJAMES777 <3886190@qq.com> Date: Tue, 23 Jun 2026 11:21:06 +0800 Subject: [PATCH] docs(#3): [$30 BOUNTY] Create CONTRIBUTING.md with build instructions --- CONTRIBUTING.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c2b2aad2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,81 @@ +# Contributing to ZeroEye + +Thank you for your interest in contributing to ZeroEye! This guide will help you get started. + +## Getting Started + +### Prerequisites + +- Python 3.10+ with pip +- Rust 1.70+ (for Rust modules) +- Node.js 18+ (for frontend modules) +- Git + +### Local Setup + +1. Fork the repository on GitHub. +2. Clone your fork: + +```bash +git clone https://github.com/YOUR_USERNAME/zeroeye.git +cd zeroeye +``` + +3. Install Python dependencies: + +```bash +python3 -m venv venv +source venv/bin/activate # On Windows: venv\Scriptsctivate +pip install -r requirements.txt # if exists +``` + +4. Verify your setup by running the build: + +```bash +python3 build.py +``` + +## Development Workflow + +1. Create a feature branch from `main`: + +```bash +git checkout -b feat/your-feature-name +``` + +2. Make your changes following the project coding style (see `.editorconfig`). + +3. Run the build to verify: + +```bash +python3 build.py +``` + +4. Commit your changes with a descriptive message: + +```bash +git commit -m "feat(#issue): description of changes" +``` + +5. Push to your fork: + +```bash +git push origin feat/your-feature-name +``` + +6. Open a Pull Request against the `main` branch. + +## Pull Request Guidelines + +- Reference the issue number in your PR title and description (e.g., `Closes #123`) +- Keep PRs focused on a single concern +- Ensure `python3 build.py` completes successfully +- Include any relevant diagnostic output + +## Code Style + +This project uses `.editorconfig` for consistent formatting across languages. Most editors support it natively or via a plugin. + +## Need Help? + +Open an issue or ask in the project discussions.