mindfry 1.9.0

Memory with a Conscience
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

# Contributing to MindFry

Thank you for your interest in contributing to MindFry! This document provides guidelines for contributing.

## Getting Started

1. **Fork the repository** on GitHub
2. **Clone your fork** locally
3. **Set up the development environment**:

   ```bash
   # Install Rust (if not already installed)
   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

   # Build the project
   cargo build

   # Run tests
   cargo test

   # Run the server
   cargo run --bin mindfry-server
   ```

## Development Workflow

### Branch Naming

- `feat/description` - New features
- `fix/description` - Bug fixes
- `docs/description` - Documentation changes
- `refactor/description` - Code refactoring
- `test/description` - Test additions/modifications

### Commit Messages

Follow [Conventional Commits](https://www.conventionalcommits.org/):

```
feat: add QUERY_PATTERN opcode support
fix: handle TCP fragmentation in large responses
docs: update README with new API examples
test: add integration tests for bond operations
```

### Code Standards

- **Zero Warnings**: All code must compile without warnings
- **Tests Required**: New features must include tests
- **Documentation**: Public APIs must be documented
- **Formatting**: Run `cargo fmt` before committing
- **Linting**: Run `cargo clippy` and address any issues

## Pull Request Process

1. **Create a feature branch** from `main`
2. **Make your changes** with clear, atomic commits
3. **Write or update tests** as needed
4. **Update documentation** if applicable
5. **Open a Pull Request** with a clear description
6. **Address review feedback** promptly

### PR Checklist

- [ ] Code compiles without warnings (`cargo build`)
- [ ] All tests pass (`cargo test`)
- [ ] Code is formatted (`cargo fmt`)
- [ ] Clippy is clean (`cargo clippy`)
- [ ] Documentation is updated (if applicable)
- [ ] CHANGELOG.md is updated (for user-facing changes)

## Areas for Contribution

### Good First Issues

Look for issues labeled `good first issue` - these are suitable for newcomers.

### High-Impact Areas

- **Performance**: Optimizing decay calculations, graph traversal
- **Documentation**: API examples, architecture guides
- **Testing**: Integration tests, property-based tests
- **Protocol**: New MFBP opcodes, client implementations

## Questions?

- Open a [Discussion](https://github.com/cluster-127/mindfry/discussions) for questions
- Check existing [Issues](https://github.com/cluster-127/mindfry/issues) before opening a new one

## License

By contributing, you agree that your contributions will be licensed under the project's Apache-2.0 license.