Skip to content

Commit 9e370d7

Browse files
committed
docs: add Contributing section to README
- Add standard contribution workflow and guidelines - Include development setup instructions - Add code standards with cargo fmt and clippy - Link to GitLab issue tracker for bug reports
1 parent ddb4512 commit 9e370d7

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,45 @@ This enables AI assistants to interact with REST APIs through a standardized int
2525
- **Comprehensive Testing**: Includes integration tests with JavaScript and Python MCP clients
2626
- **Built with Official SDK**: Uses the official Rust MCP SDK for reliable protocol compliance
2727

28+
## Contributing
29+
30+
We welcome contributions to `rmcp-openapi`! Please follow these guidelines:
31+
32+
### How to Contribute
33+
34+
1. **Fork the repository** on GitLab
35+
2. **Create a feature branch** from `main`: `git checkout -b feature/my-new-feature`
36+
3. **Make your changes** and ensure they follow the project's coding standards
37+
4. **Add tests** for your changes if applicable
38+
5. **Run the test suite** to ensure nothing is broken: `cargo test`
39+
6. **Commit your changes** with clear, descriptive commit messages
40+
7. **Push to your fork** and **create a merge request**
41+
42+
### Development Setup
43+
44+
```bash
45+
# Clone your fork
46+
git clone https://gitlab.com/your-username/rmcp-openapi.git
47+
cd rmcp-openapi
48+
49+
# Build the project
50+
cargo build --workspace
51+
52+
# Run tests
53+
cargo test
54+
```
55+
56+
### Code Standards
57+
58+
- Follow Rust conventions and use `cargo fmt` to format code
59+
- Run `cargo clippy --all-targets` to catch common mistakes
60+
- Add documentation for public APIs
61+
- Include tests for new functionality
62+
63+
### Reporting Issues
64+
65+
Found a bug or have a feature request? Please report it on our [GitLab issue tracker](https://gitlab.com/lx-industries/rmcp-openapi/-/issues).
66+
2867
## Installation
2968

3069
### Install Server Binary

0 commit comments

Comments
 (0)