diff --git a/CHANGELOG.md b/CHANGELOG.md index 2b6ae7a4aa..64cb9051b8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ While we try to keep the `Unreleased` changes updated, it is often behind and do all merged pull requests. To see a list of all changes since the latest release, you may compare current changes on git with [previous release tags][git_tag_comparison]. -[git_tag_comparison]: https://github.com/bevyengine/bevy/compare/v0.4.0...master +[git_tag_comparison]: https://github.com/bevyengine/bevy/compare/v0.4.0...main ## Version 0.4.0 (2020-12-19) diff --git a/README.md b/README.md index 0a1e1976bd..b459746f51 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # [![Bevy](assets/branding/bevy_logo_light_small.svg)](https://bevyengine.org) [![Crates.io](https://img.shields.io/crates/v/bevy.svg)](https://crates.io/crates/bevy) -[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bevyengine/bevy/blob/master/LICENSE) +[![license](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) [![Crates.io](https://img.shields.io/crates/d/bevy.svg)](https://crates.io/crates/bevy) [![Rust](https://github.com/bevyengine/bevy/workflows/CI/badge.svg)](https://github.com/bevyengine/bevy/actions) ![iOS cron CI](https://github.com/bevyengine/bevy/workflows/iOS%20cron%20CI/badge.svg) @@ -38,7 +38,7 @@ 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)** and +Before contributing or participating in discussions with the community, you should familiarize yourself with our **[Code of Conduct](./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. diff --git a/docs/plugins_guidelines.md b/docs/plugins_guidelines.md index c2689a919d..036a56be7c 100644 --- a/docs/plugins_guidelines.md +++ b/docs/plugins_guidelines.md @@ -10,7 +10,7 @@ This document targets plugin authors. * [ ] [Pick a reasonable, descriptive name](#naming) * [ ] [Bevy/plugin version support table](#bevy-version-supported) * [ ] [Turn off default Bevy features](#bevy-features) -* [ ] [Choose a Bevy git/master tracking badge](#master-branch-tracking) +* [ ] [Choose a Bevy git/main tracking badge](#main-branch-tracking) * [ ] [Pick a license](#licensing) * [ ] [Remove unnecessary or redundant dependencies](#small-crate-size) * [ ] [Add cargo tests and CI](#tests-and-ci) @@ -46,20 +46,20 @@ You should disable Bevy features that you don't use. This is because with Cargo, bevy = { version = "0.4", default-features = false, features = ["..."] } ``` -## Master Branch Tracking +## Main Branch Tracking -If you intend to track Bevy's master branch, you can specify the latest commit you support in your `Cargo.toml` file: +If you intend to track Bevy's main branch, you can specify the latest commit you support in your `Cargo.toml` file: ``` bevy = { version = "0.4", git = "https://github.com/bevyengine/bevy", rev="509b138e8fa3ea250393de40c33cc857c72134d3", default-features = false } ``` You can specify the dependency [both as a version and with git](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#multiple-locations), the version will be used if using the dependency from [crates.io](https://crates.io), the git dependency will be used otherwise. -Bevy is evolving very fast. You can use one of these badges to communicate to your users how closely you intend to track Bevy's master branch. +Bevy is evolving very fast. You can use one of these badges to communicate to your users how closely you intend to track Bevy's main branch. |
badge
|
description
|code| |-|-|-| -|[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-master-lightblue)](https://github.com/bevyengine/bevy/blob/master/docs/plugins_guidelines.md#master-branch-tracking)|I intend to track master as much as I can|`[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-master-lightblue)](https://github.com/bevyengine/bevy/blob/master/docs/plugins_guidelines.md#master-branch-tracking)`| -|[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue)](https://github.com/bevyengine/bevy/blob/master/docs/plugins_guidelines.md#master-released%20version-tracking)|I will only follow released Bevy versions|`[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue)](https://github.com/bevyengine/bevy/blob/master/docs/plugins_guidelines.md#master-released%20version-tracking)`| +|[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-main-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)|I intend to track main as much as I can|`[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-main-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)`| +|[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)|I will only follow released Bevy versions|`[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)`| ## General Advices for a Rust Crate @@ -67,7 +67,7 @@ This advice is valid for any Rust crate. ### Licensing -Rust projects are often dual licensed with [MIT and Apache 2.0](https://www.rust-lang.org/policies/licenses). Bevy is licensed with [MIT](https://github.com/bevyengine/bevy/blob/master/LICENSE). Those are great options to license your plugin. +Rust projects are often dual licensed with [MIT and Apache 2.0](https://www.rust-lang.org/policies/licenses). Bevy is licensed with [MIT](https://github.com/bevyengine/bevy/blob/main/LICENSE). Those are great options to license your plugin. ### Small Crate Size @@ -91,7 +91,7 @@ Additionally, it can be helpful to list: ### Tests and CI -Tests are always good! For CI, you can check [this example](https://github.com/actions-rs/meta/blob/master/recipes/quickstart.md) for a quickstart using GitHub Actions. As Bevy has additional Linux dependencies, you should install them before building your project, [here is how Bevy is doing it](https://github.com/bevyengine/bevy/blob/cf0e9f9968bb1bceb92a61cd773478675d35cbd6/.github/workflows/ci.yml#L39). Even if you don't have many (or any) tests, setting up CI will compile check your plugin and ensure a basic level of quality. +Tests are always good! For CI, you can check [this example](https://github.com/actions-rs/meta/blob/main/recipes/quickstart.md) for a quickstart using GitHub Actions. As Bevy has additional Linux dependencies, you should install them before building your project, [here is how Bevy is doing it](https://github.com/bevyengine/bevy/blob/cf0e9f9968bb1bceb92a61cd773478675d35cbd6/.github/workflows/ci.yml#L39). Even if you don't have many (or any) tests, setting up CI will compile check your plugin and ensure a basic level of quality. ### Publishing your Plugin