secretscan 0.2.0

A blazing-fast secret scanner for your codebase
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# Contributing to Secretscan

Thank you for your interest in contributing to secretscan! We welcome contributions from the community and are grateful for any help you can provide.

## Code of Conduct

By participating in this project, you agree to abide by our code of conduct. Please be respectful and considerate in all interactions.

## How to Contribute

### Reporting Issues

- Check if the issue has already been reported
- Use the issue template when creating new issues
- Provide as much detail as possible, including:
  - Your operating system and version
  - Rust version (`rustc --version`)
  - Steps to reproduce the issue
  - Expected vs actual behavior

### Submitting Pull Requests

1. **Fork the repository** and create your branch from `main`
2. **Install Rust** (latest stable version)
3. **Run tests** to ensure everything works: `cargo test`
4. **Make your changes** following our coding standards
5. **Add tests** for any new functionality
6. **Update documentation** as needed
7. **Run the full test suite**: 
   ```bash
   cargo test
   cargo clippy -- -D warnings
   cargo fmt --check
   ```
8. **Submit a pull request** with a clear description of your changes

### Development Setup

```bash
# Clone your fork
git clone https://github.com/marcuspat/secret-scan.git
cd secretscan

# Install dependencies and build
cargo build

# Run tests
cargo test

# Run with debug output
RUST_LOG=debug cargo run -- scan .

# Run benchmarks
cargo bench
```

### Coding Standards

- Follow Rust's official style guidelines
- Use `cargo fmt` to format your code
- Use `cargo clippy` to check for common mistakes
- Write descriptive commit messages
- Add comments for complex logic
- Update documentation for public APIs

### Testing

- Write unit tests for new functionality
- Add integration tests for new features
- Ensure all tests pass before submitting PR
- Aim for high test coverage
- Test edge cases and error conditions

### Documentation

- Update README.md if adding new features
- Add rustdoc comments for public functions
- Update CHANGELOG.md following Keep a Changelog format
- Include examples in documentation

### Performance Considerations

Since secretscan is performance-critical:
- Profile your changes with `cargo bench`
- Avoid unnecessary allocations
- Use parallel processing where appropriate
- Consider memory usage for large codebases

## Development Guidelines

### Adding New Secret Patterns

1. Add pattern to `src/patterns.rs`
2. Add test cases in `tests/pattern_test.rs`
3. Update documentation with new pattern
4. Consider entropy requirements

### Improving Performance

1. Run benchmarks before and after changes
2. Use flamegraphs to identify bottlenecks
3. Consider parallelization opportunities
4. Minimize regex compilations

## Release Process

1. Update version in `Cargo.toml`
2. Update CHANGELOG.md
3. Create a PR with version bump
4. After merge, tag the release
5. Publish to crates.io

## Getting Help

- Check the documentation
- Look through existing issues
- Ask questions in discussions
- Reach out to maintainers

## Recognition

Contributors will be recognized in:
- The project README
- Release notes
- GitHub contributors page

Thank you for contributing to secretscan!