Contributing to OxiCloud

Thank you for your interest in contributing to OxiCloud! This document provides guidelines and instructions for contributing to the project.

Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for everyone. Please be considerate of other contributors and users.

How to Contribute

There are many ways to contribute to OxiCloud:

Reporting bugs
Suggesting enhancements
Writing documentation
Improving code
Adding translations

Reporting Bugs

If you find a bug, please create an issue with the following information:

A clear, descriptive title
Steps to reproduce the issue
Expected behavior
Actual behavior
Screenshots if applicable
System information (OS, browser, etc.)

Suggesting Enhancements

Enhancement suggestions are welcome! Please include:

A clear and detailed explanation of the feature
Why this feature would be useful to most OxiCloud users
Possible implementation approaches if you have ideas

Pull Request Process

Fork the repository
Create your feature branch (git checkout -b feature/something-useful)
Make your changes
Run the tests and linters to ensure your code meets our quality standards:
```
cargo test
cargo clippy
cargo fmt --check
```
Commit your changes with a descriptive message
Push to your branch
Create a Pull Request to the dev branch

Development Guidelines

Please follow the development guidelines in the CLAUDE.md file, which include:

Code style guidelines
Architecture principles
Testing requirements
Documentation standards

Development Environment Setup

Follow the setup instructions in the README.md to set up your development environment.

Getting Help

If you need help with the contribution process or have questions, feel free to:

Open an issue with your question
Reach out to the maintainers

Thank you for contributing to OxiCloud!

2.0 KiB Raw Permalink Blame History