Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (29 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 1.49 KB

Contributing to xtop

First off, thank you for considering contributing to xtop! It's people like you that make this tool better.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with the enhancement label.
  • Provide a clear and detailed explanation of the feature you want and why it's important.

Pull Requests

  1. Fork the repository and create your branch from main.
  2. Ensure you have installed the necessary dependencies (Rust & Cargo).
  3. Make your changes and test them locally using cargo run.
  4. Run cargo fmt and cargo clippy to ensure code quality and formatting.
  5. Create a pull request. Make sure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Development Setup

# Clone the repository
git clone https://github.com/xscriptor/xtop.git
cd xtop

# Build the project
cargo build

# Run the project
cargo run

# Run tests (if applicable)
cargo test

Community

If you have questions or need help, feel free to reach out via GitHub issues or discussions (if enabled).