Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a CONTRIBUTING.md #1309

Merged
merged 3 commits into from
Jan 26, 2021
Merged

Add a CONTRIBUTING.md #1309

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f35d98
Add a CONTRIBUTING.md
CleanCut Jan 24, 2021
859793f
Point to book. Add tools/ci script.
CleanCut Jan 25, 2021
2099808
Update contributing link to point to book
CleanCut Jan 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# How to Contribute

1. Fork the repository
2. Make your changes in a local clone of your fork
4. For a higher chance of CI passing the first time, consider running the following commands and fixing any errors or warnings (CI is currently pinned to a specific nightly version, so results may not match exactly):
1. `cargo fmt`
CleanCut marked this conversation as resolved.
Show resolved Hide resolved
2. `cargo clippy`
5. Push your changes to your fork and open a [Pull Request][pull]
6. Respond to any CI failures or review feedback.

Remember to follow Bevy's [Code of Conduct][coc], and thanks for contributing!

[coc]: https://github.com/bevyengine/bevy/blob/master/CODE_OF_CONDUCT.md
[pull]: https://github.com/bevyengine/bevy/compare
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ Bevy is still in the _very_ early stages of development. APIs can and will chang

## 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://github.com/bevyengine/bevy/blob/master/CONTRIBUTING.md)**
CleanCut marked this conversation as resolved.
Show resolved Hide resolved

* **[Discord](https://discord.gg/gMUk5Ph):** Bevy's official discord server.
* **[Reddit](https://reddit.com/r/bevy):** Bevy's official subreddit.
Expand Down