Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 791 Bytes

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 791 Bytes

Code of conduct

Cask uses Rust's Code of Conduct. In the forums, every community member must follow the rules and values expressed there

Code style

Code style follows Rust's style.

  1. Format with rustfmt
  2. Lint with clippy
  3. File name follows the principle of underline splicing

How to contribute?

  1. Fork repository

    Click the button [Fork] on the web

  2. Clone your forked repository

    git clone https://github.com/<username>/cask.rs
    cd cask.rs
  3. Checkout to a new branch

    git checkout -b fix_bug

    Then add or modify the code.

  4. Commit the changes

    git commit -m "<commit message>"
    git push
  5. Create a pull request

    Follow the instructions, create a PR on Github and wait for review.