Skip to content

Latest commit

 

History

History
51 lines (27 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

51 lines (27 loc) · 2.65 KB
Raw

Contributing Guidelines

Welcome, and thank you for your interest in contributing to rustcloud! We appreciate your help and encourage you to follow these guidelines to make the contribution process smooth and efficient.

Proposing New Features or Bug Fixes

Note: Before starting work on a new feature or bug fix, please ensure you’ve created an issue to discuss your proposal and gather feedback.

  • Check for Existing Issues: Ensure there is an open issue discussing your contribution. If not, please open a new issue to discuss your proposal before you start working on it.
  • Provide Details: When creating an issue, include as much detail as possible to help us understand your proposal. Follow the issue template to provide necessary information.

Working on Existing Issues

Note: If you want to work on an existing issue, please comment on the issue to confirm that you intend to work on it and to ensure it is still relevant.

Reviewing Pull Requests

Reviewing pull requests (PRs) is a valuable way to contribute to rustcloud. Your feedback helps improve the quality of contributions and speeds up the review process.

Writing / Improving Documentation

Note: Documentation is crucial for users and contributors. We encourage you to help improve the documentation. If you have suggestions for documentation improvements or need to add new documentation, please create a PR with your changes.

Providing Support

Helping others with their issues or questions is a great way to contribute. Engage with users facing difficulties, and provide support and guidance to enhance their experience with rustcloud.

Code Style

We strive for clean and consistent code throughout rustcloud. We use rustfmt for formatting and clippy for linting. Please ensure your code adheres to these tools to maintain consistency.

  • Formatting: Use rustfmt to format your code. Run cargo fmt to format your code.
  • Linting: Use clippy to lint your code. Run cargo clippy to check for potential issues.

To help maintain consistency, an .editorconfig file is provided. Configure your editor to use this file to automatically apply the specified style settings.

Testing

We aim for comprehensive test coverage to ensure the reliability of rustcloud. Make sure your changes are well-tested.

Test Coverage

Note: Add tests for your changes to ensure they work correctly. Aim for high coverage to catch potential issues early.

Code of Conduct

To ensure a positive and respectful environment for everyone in our community, please read our Code of Conduct. It outlines our core values and expectations for behavior.