Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-25 14:10:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update engine_style_guide with guideline to link to the error code when using bevy engine error codes (#12253)

Browse source 
# Objective

- https://github.com/bevyengine/bevy/pull/12165 created the expectation
that returned bevy errors will include a link to the relevant bevy
error. That expectation is not formally established in the contributing
guidelines which will lead to it not being upheld in future PRs that use
the bevy error codes. This PR adds it to engine_style_guide.md to
establish that convention officially

---------

Co-authored-by: Afonso Lage <lage.afonso@gmail.com>
This commit is contained in:
Noah 2024-03-02 09:42:29 -05:00 committed by GitHub
parent 8dd5692b3e
commit 45f7af6282
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.github/contributing/engine_style_guide.md vendored
View file

@ -14,6 +14,7 @@ For more advice on contributing to the engine, see the [relevant section](../../
4. Use \`variable_name\` code blocks in comments to signify that you're referring to specific types and variables.
5. Start comments with capital letters. End them with a period if they are sentence-like.
3. Use comments to organize long and complex stretches of code that can't sensibly be refactored into separate functions.
4. When using [Bevy error codes](https://bevyengine.org/learn/errors/) include a link to the relevant error on the Bevy website in the returned error message `... See: https://bevyengine.org/learn/errors/#b0003`.
## Rust API guidelines