CONTRIBUTING.md

# Contributing to Rust Web Server

Thank you for your interest in contributing to the Rust Web Server project! We welcome contributions from the community.

## 🚀 Getting Started

### Prerequisites

- Rust 1.70+ installed
- Cargo package manager
- Git

### Development Setup

1. Fork the repository
2. Clone your fork:
```bash
git clone https://github.com/your-username/rust-web-server.git
cd rust-web-server
```

3. Set up the development environment:
```bash
make setup
```

4. Run the server in development mode:
```bash
make dev
```

## 🛠️ Development Workflow

### Code Style

- Follow Rust's official style guidelines
- Use `cargo fmt` to format your code
- Run `cargo clippy` to check for linting issues
- Maximum line length: 100 characters

### Testing

- Write tests for new features
- Run the test suite:
```bash
make test
```

- Ensure all tests pass before submitting a PR

### Commit Messages

Use clear, descriptive commit messages following this format:

```
type(scope): description

[optional body]

[optional footer]
```

Types:
- `feat`: New feature
- `fix`: Bug fix
- `docs`: Documentation
- `style`: Code style changes
- `refactor`: Code refactoring
- `test`: Adding tests
- `chore`: Maintenance

## 📋 Pull Request Process

1. Create a feature branch from `main`:
```bash
git checkout -b feature/your-feature-name
```

2. Make your changes and ensure tests pass:
```bash
make ci
```

3. Update documentation if needed

4. Commit your changes:
```bash
git commit -m "feat: add new feature"
```

5. Push to your fork:
```bash
git push origin feature/your-feature-name
```

6. Create a Pull Request with:
- Clear title and description
- Reference any related issues
- Screenshots/demo if applicable

## 🧪 Testing Guidelines

### Unit Tests

- Place unit tests in the same file as the code they're testing
- Use descriptive test names
- Test both success and error cases

### Integration Tests

- Place integration tests in `tests/` directory
- Test API endpoints and external integrations

### Manual Testing

- Test the web interface in different browsers
- Test API endpoints with tools like curl or Postman
- Test file uploads and WebSocket connections

## 📚 Documentation

- Update README.md for new features
- Add doc comments to public APIs
- Update API documentation in the web interface

## 🐛 Reporting Bugs

When reporting bugs, please include:

- Clear description of the issue
- Steps to reproduce
- Expected vs actual behavior
- Environment details (OS, Rust version, etc.)
- Screenshots/logs if applicable

## 💡 Feature Requests

We welcome feature requests! Please:

- Check if the feature already exists or is planned
- Describe the use case clearly
- Explain why it would be valuable
- Consider implementation complexity

## 📞 Contact

For questions or discussions:

- **Issues**: Use GitHub issues for bugs and feature requests
- **Discussions**: Use GitHub discussions for general questions
- **Email**: hello@rskworld.in

## 📜 Code of Conduct

This project follows a code of conduct to ensure a welcoming environment for all contributors.

---

**© 2026 RSK World. All rights reserved.**