de-sh/contribution_checklist.md

Last active June 16, 2022 15:18

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/de-sh/33e6af16060038dcf7e00d786d9029cc.js"></script>
Save de-sh/33e6af16060038dcf7e00d786d9029cc to your computer and use it in GitHub Desktop.

Download ZIP

A list of action items to be performed before opening a PR on your favourite rust project

Raw

contribution_checklist.md

Run rust's code formatter cargo fmt.
Run clippy cargo clippy.
Run test suite cargo test.
Does the proposed change behave as expected?
Document how the changes affect the previously known behaviour of the component/product.

Some of this might be a bit boring to repeat, so I wrote a shell script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment