voicepeak-cli 0.4.2

A command-line interface wrapper for VOICEPEAK text-to-speech software
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

# Contributing to voicepeak-cli

Thank you for your interest in contributing to voicepeak-cli! We welcome contributions from everyone.

## Bug Reports and Feature Requests

- Use the [GitHub Issues](https://github.com/petamorikei/voicepeak-cli/issues) to report bugs or request features
- Please search existing issues before creating a new one
- Provide as much detail as possible, including:
  - Your operating system and version
  - VOICEPEAK version
  - Steps to reproduce the issue
  - Expected vs actual behavior

## Code Contributions

1. Fork the repository
2. Create a feature branch: `git checkout -b feature/your-feature-name`
3. Make your changes
4. Add tests if applicable
5. Run the test suite: `cargo test`
6. Check formatting: `cargo fmt`
7. Run clippy: `cargo clippy`
8. Commit your changes: `git commit -am 'Add some feature'`
9. Push to the branch: `git push origin feature/your-feature-name`
10. Create a Pull Request

## Development Setup

```bash
# Clone the repository
git clone https://github.com/petamorikei/voicepeak-cli.git
cd voicepeak-cli

# Build the project
cargo build

# Run tests
cargo test

# Install locally for testing
cargo install --path .
```

## Code Style

- Follow Rust standard formatting (`cargo fmt`)
- Ensure all clippy lints pass with CI-level strictness
- Write tests for new functionality
- Update documentation as needed

### Running CI-equivalent checks locally

To ensure your code passes CI, run the same checks locally:

```bash
# Check compilation (same as CI)
cargo check

# Format check (same as CI)
cargo fmt --all -- --check

# Clippy check (same as CI)
cargo clippy

# Fix formatting issues
cargo fmt

# Fix clippy issues where possible
cargo clippy --fix
```

## Commit Message Guidelines

- Use clear and descriptive commit messages
- Start with a verb in imperative mood (e.g., "Add", "Fix", "Update")
- Keep the first line under 50 characters
- Reference issues when applicable (e.g., "Fix #123")

## Pull Request Process

1. Update the README.md with details of changes if applicable
2. Update the version numbers in Cargo.toml following [Semantic Versioning](https://semver.org/)
3. The PR will be merged once you have the sign-off of a maintainer

## Questions?

If you have any questions about contributing, feel free to open an issue or reach out to the maintainers.

Thank you for contributing!