Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

27 lines (18 loc) · 1.24 KB
Raw

Contributing to near-sdk-rs

Thank you for your interest in contributing to NEAR's Rust SDK! We appreciate any type of contribution.

If you have any questions about contributing, or about the project in general, please ask in our rust-sdk Discord channel.

Code of Conduct

We have an open and welcoming environment, please review our code of conduct.

Development

Commits

Please use descriptive PR titles. We loosely follow the conventional commits style, but this is not a requirement to follow exactly. PRs will be addressed more quickly if it is clear what the intention is.

Before opening a PR

Ensure the following are satisfied before opening a PR:

  • Code is formatted with rustfmt by running cargo fmt
  • Run clippy
    • The exact command run by the CI is cargo clippy --tests -- -Dclippy::all
  • Run tests with cargo test
  • Test all examples with ./examples/test_all.sh
    • This must be done after the previous step
  • Ensure any new functionality is adequately tested
  • If any new public types or functions are added, ensure they have appropriate rustdoc documentation