Skip to content

Commit bdb6239

Browse files
docs: Add CONTRIBUTING.md for contributor
1 parent 91f4370 commit bdb6239

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed

CONTRIBUTING.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Contributing to queensac
2+
3+
Thank you for your interest in contributing to queensac!! We welcome all kinds of contributions, from bug reports to feature requests and code contributions.
4+
5+
## Getting Started
6+
7+
1. Fork the repository
8+
2. Clone your fork locally:
9+
```bash
10+
git clone https://github.com/your-username/queensac.git
11+
cd queensac
12+
```
13+
3. Install Rust if you haven't already: https://rustup.rs/
14+
4. Build the project:
15+
```bash
16+
cargo build
17+
```
18+
19+
## Development Workflow
20+
21+
### Making Changes
22+
23+
1. Create a new branch for your changes (any branch naming convention is fine)
24+
2. Make your changes
25+
3. Test your changes thoroughly
26+
27+
### Commit Convention
28+
29+
This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for commit messages.
30+
31+
### Code Quality Checks
32+
33+
Before submitting your pull request, please ensure that your code passes all the following checks:
34+
35+
#### 1. Linting with Clippy
36+
Run Clippy to catch common mistakes and improve code quality:
37+
```bash
38+
cargo clippy -- -D warnings
39+
```
40+
This command will treat all warnings as errors. Please fix any issues that arise.
41+
42+
#### 2. Code Formatting
43+
Ensure your code follows the standard Rust formatting:
44+
```bash
45+
cargo fmt -- --check
46+
```
47+
If this command fails, run `cargo fmt` to automatically format your code.
48+
49+
#### 3. Tests
50+
Make sure all tests pass:
51+
```bash
52+
cargo test
53+
```
54+
55+
## Submitting Changes
56+
57+
1. Push your changes to your fork
58+
2. Create a Pull Request with:
59+
- A clear title describing your changes
60+
- A detailed description of what you've changed and why
61+
- Any relevant issue numbers (e.g., "Fixes #123")
62+
63+
## Types of Contributions
64+
65+
- **Bug Reports**: Use GitHub Issues to report bugs
66+
- **Feature Requests**: Suggest new features through GitHub Issues
67+
- **Documentation**: Improve README, code comments, or other documentation
68+
- **Code**: Bug fixes, feature implementations, performance improvements
69+
70+
## Code Guidelines
71+
72+
- Write clear, readable code with appropriate comments
73+
- Follow Rust best practices and idioms
74+
- Add tests for new functionality
75+
- Update documentation as needed
76+
77+
## Getting Help
78+
79+
If you have questions about contributing, feel free to:
80+
- Open an issue for discussion
81+
- Look at existing issues and PRs for examples
82+
- Reach out to the maintainers
83+
84+
Thank you for contributing to queensac!!

0 commit comments

Comments
 (0)