Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (32 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 1.67 KB

Contributing to sthub

Thank you for your interest in contributing to sthub! Your help is greatly appreciated. This project is under active development, and contributions of all kinds are welcome.

How to Contribute

  • Bug Reports & Feature Requests
    Please use the GitHub Issues page to report bugs, request features, or suggest enhancements. Make sure to check if your issue hasn’t been reported already.

  • Pull Requests
    We welcome pull requests for fixes, features, documentation, and tests. Please follow these steps:

    1. Fork the repository.
    2. Create a new branch (git checkout -b feature/your-feature).
    3. Make your changes, and write clear commit messages.
    4. Ensure code compiles and run tests (cargo test).
    5. Open a pull request against the main branch with a description of your changes.

  • Code Style & Guidelines

    • Keep the code clean, readable, and idiomatic to Rust.
    • Document public functions and added features.
    • Add or update tests when relevant.

Setting Up the Project

To get started with local development:

  1. Clone the repository:
    git clone https://github.com/shackerd/sthub.git
  2. Enter the directory:
    cd sthub
  3. Build the project:
    cargo build
  4. Run tests:
    cargo test

Code of Conduct

Please treat everyone with respect and kindness. This project adheres to the Rust Code of Conduct. Harassment or discrimination will not be tolerated.

Questions

If you have any questions or need help, don’t hesitate to open an issue or start a discussion.

Looking forward to your contributions! 🚀