mirror of
https://github.com/bevyengine/bevy
synced 2024-11-25 06:00:20 +00:00
Add Contributing Info (#1309)
* Add a CONTRIBUTING.md * Point to book. Add tools/ci script. * Update contributing link to point to book
This commit is contained in:
parent
f3306e5490
commit
940bcf9b0f
3 changed files with 26 additions and 1 deletions
4
.github/CONTRIBUTING.md
vendored
Normal file
4
.github/CONTRIBUTING.md
vendored
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
Please see the [Contributing Code](https://bevyengine.org/learn/book/contributing/code/) section of
|
||||||
|
[The Book](https://bevyengine.org/learn/book/introduction/).
|
|
@ -36,7 +36,8 @@ Bevy is still in the _very_ early stages of development. APIs can and will chang
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
Before contributing or participating in discussions with the community, you should familiarize yourself with our **[Code of Conduct](https://github.com/bevyengine/bevy/blob/master/CODE_OF_CONDUCT.md)**
|
Before contributing or participating in discussions with the community, you should familiarize yourself with our **[Code of Conduct](https://github.com/bevyengine/bevy/blob/master/CODE_OF_CONDUCT.md)** and
|
||||||
|
**[How to Contribute](https://bevyengine.org/learn/book/contributing/code/)**
|
||||||
|
|
||||||
* **[Discord](https://discord.gg/gMUk5Ph):** Bevy's official discord server.
|
* **[Discord](https://discord.gg/gMUk5Ph):** Bevy's official discord server.
|
||||||
* **[Reddit](https://reddit.com/r/bevy):** Bevy's official subreddit.
|
* **[Reddit](https://reddit.com/r/bevy):** Bevy's official subreddit.
|
||||||
|
|
20
tools/ci
Executable file
20
tools/ci
Executable file
|
@ -0,0 +1,20 @@
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
# This script is intended to mimic some CI behavior that we encourage contributors to run locally.
|
||||||
|
# For the actual CI run on GitHub, see the files in .github/workflows/
|
||||||
|
|
||||||
|
# Exit when any command fails
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# Keep track of the last executed command
|
||||||
|
trap 'last_command=$current_command; current_command=$BASH_COMMAND' DEBUG
|
||||||
|
# Echo an error message before exiting, so you can see exactly what command and what error code
|
||||||
|
trap 'echo "\"${last_command}\" command filed with exit code $?."' EXIT
|
||||||
|
|
||||||
|
## ACTUAL COMMANDS
|
||||||
|
|
||||||
|
# Auto-format Rust files
|
||||||
|
cargo +nightly fmt --all
|
||||||
|
|
||||||
|
# Run a more intensive linter
|
||||||
|
cargo clippy --all-targets --all-features -- -D warnings -A clippy::type_complexity -A clippy::manual-strip
|
Loading…
Reference in a new issue