53ed7bf7ed
* fix included examples and markdown(book) fixes: #911 * fix footnote pre_init * more example link updates * Restore pool example name * Example: pool: Upgrade to heapless v0.8 * Example: pool: thumbv6 unsupported: wild cfg-if Experiment with multi-backend example contained in the example * Example: lm3s6965: Updated cargo.lock * Book: Use cargo xtask for by-example * Docs: Contributing: cargo xtask --------- Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
1.7 KiB
Contributing
New features
New features should go through the RFC process before creating a Pull Request to this repository.
Bugs
Report bugs by creating an issue in this repository.
Pull Requests (PRs)
Please make pull requests against the master branch.
Always use rebase instead of merge when bringing in changes from master to your feature branch.
Writing documentation
Documentation improvements are always welcome.
The source for the book is in book/ and API documentation is generated from the source code.
CI test preparation
Continuous Integration (CI) tests are run against all pull requests.
Please make sure that tests passes locally before submitting.
Cargo format
> cargo fmt
Example check
> cargo xtask example-check
Run examples/tests on QEMU device
> cargo xtask qemu
Will execute examples on your local qemu install.
Adding examples/tests to xtask
If you have added further tests, you need to add the expected output in the ci/expected folder.
> cargo xtask qemu --overwrite-expected
Internal tests
Run internal fail tests locally with:
> cargo xtask test
Adding tests to internal tests
If you have added fail tests or changed the expected behavior, the expected output needs to be updated (corresponding .stderr files).
Inspect the error output, when sure that ACTUAL OUTPUT is correct you can re-run the test as:
> TRYBUILD=overwrite cargo xtask test
This will update the expected output to match the ACTUAL OUTPUT.
Please check that the updated files are indeed correct to avoid regressions.