Skip to content

Commit a1c1e50

Browse files
docs: Include the 'CONTRIBUTING.md' explanation.
1 parent e43b9e1 commit a1c1e50

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# How to Contribute to Edge Python
2+
3+
Thanks for your interest in contributing to Edge. This document outlines some recommendations on how to contribute.
4+
5+
## Issues and Feature Requests
6+
7+
Please provide a failing example if possible to help with issue reproduction.
8+
9+
## Pull Requests
10+
11+
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.
12+
13+
Run the following commands before sending a pull request to ensure code quality:
14+
15+
- `cargo wasm` Build the `compiler.wasm`.
16+
- `cargo test --release --no-default-features` Run the compiler test suite.
17+
- `cargo clippy --all-targets --no-default-features -- -D warnings` Lint the Rust code.
18+
19+
*Other packages have their own build and test setup — take a look at the `README.md` in the relevant path.*
20+
21+
A CI job will be run by the maintainer after the PR has been created.

0 commit comments

Comments
 (0)