You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
Before submitting a bug report, please check that it hasn't already been reported. If you find a bug that hasn't been reported, create an issue on the repository with the following information:
45
+
46
+
- A clear, descriptive title
47
+
- Steps to reproduce the issue
48
+
- Expected behavior
49
+
- Actual behavior
50
+
- Screenshots or code snippets if applicable
51
+
- Environment information (OS, Rust version, etc.)
52
+
53
+
### Suggesting Enhancements
54
+
55
+
Enhancement suggestions are tracked as GitHub issues. Create an issue with:
56
+
57
+
- A clear, descriptive title
58
+
- Detailed explanation of the proposed feature
59
+
- Any possible implementation details or ideas
60
+
- Relevant examples of how the feature would be used
61
+
62
+
### Pull Requests
63
+
64
+
1. Update your fork to the latest upstream version
65
+
```bash
66
+
git fetch upstream
67
+
git merge upstream/main
68
+
```
69
+
2. Create a new branch for your changes
70
+
3. Make your changes following the coding guidelines
71
+
4. Add or update tests as needed
72
+
5. Update documentation as needed
73
+
6. Commit your changes with clear commit messages
74
+
7. Push your branch to your fork
75
+
8. Submit a pull request to the main repository
76
+
77
+
For pull requests, please:
78
+
79
+
- Include a clear description of the changes
80
+
- Link any related issues
81
+
- Update relevant documentation
82
+
- Ensure all tests pass
83
+
- Follow the coding style guidelines
84
+
85
+
## Development Setup
86
+
87
+
1. Ensure you have Rust and Cargo installed (minimum version 1.60)
88
+
2. Install required dependencies
89
+
```bash
90
+
cargo build
91
+
```
92
+
3. Set up pre-commit hooks (optional)
93
+
```bash
94
+
cargo install cargo-husky
95
+
cargo husky install
96
+
```
97
+
98
+
## Coding Guidelines
99
+
100
+
- Follow the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/)
101
+
- Use `rustfmt` for code formatting (run `cargo fmt` before committing)
102
+
- Run `cargo clippy` to catch common mistakes and improve code quality
103
+
- Write clear comments for public API functions
104
+
- Maintain backward compatibility where possible
105
+
106
+
## Commit Message Guidelines
107
+
108
+
- Use the present tense ("Add feature" not "Added feature")
109
+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
110
+
- Limit the first line to 72 characters or less
111
+
- Reference issues and pull requests liberally after the first line
112
+
- Consider starting the commit message with an applicable prefix:
113
+
-`feat:` for new features
114
+
-`fix:` for bug fixes
115
+
-`docs:` for documentation changes
116
+
-`style:` for formatting changes
117
+
-`refactor:` for code refactoring
118
+
-`test:` for adding or modifying tests
119
+
-`chore:` for changes to the build process or auxiliary tools
120
+
121
+
## Testing
122
+
123
+
- Write tests for all new features and bug fixes
124
+
- Ensure all existing tests pass before submitting a pull request
125
+
- Run tests with `cargo test`
126
+
- For performance-critical code, include benchmarks
127
+
128
+
## Documentation
129
+
130
+
- Document all public API functions, types, and modules
0 commit comments