Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (13 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

23 lines (13 loc) · 1.03 KB

How to Contribute to Edge Python

Thanks for your interest in contributing to Edge. This document outlines some recommendations on how to contribute.

Issues and Feature Requests

Please provide a failing example if possible to help with issue reproduction.

Pull Requests

For large changes, please try reaching out to the Edge maintainers via GitHub Issues or Email to ensure that the change can be accepted once it is ready.

Run the following commands before sending a pull request to ensure code quality:

  • cargo wasm Build the compiler.wasm.
  • cargo test --release --no-default-features Run the compiler test suite.
  • cargo clippy --all-targets --no-default-features -- -D warnings Lint the Rust code.

Other packages have their own build and test setup — take a look at the README.md in the relevant path.

A CI job will be run by the maintainer after the PR has been created.

PRs that introduce new behavior without test coverage, or that update documentation without reflecting the actual code change, will not be accepted.