diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8ddc5827c7..9108a0e224 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,7 +8,7 @@ To help us review it efficiently, please ensure you've gone through the followin - [ ] I have used `cargo xtask fmt-packages` command to ensure that all changed code is formatted correctly. - [ ] My changes were added to the [`CHANGELOG.md`](https://github.com/esp-rs/esp-hal/blob/main/esp-hal/CHANGELOG.md) in the **_proper_** section. - [ ] I have added necessary changes to user code to the [Migration Guide](https://github.com/esp-rs/esp-hal/blob/main/esp-hal/MIGRATING-0.21.md). -- [ ] My changes are in accordance to the [esp-rs API guidelines](https://github.com/esp-rs/esp-hal/blob/main/documentation/API-GUIDELINES.md) +- [ ] My changes are in accordance to the [esp-rs developer guidelines](https://github.com/esp-rs/esp-hal/blob/main/documentation/DEVELOPER-GUIDELINES.md) #### Extra: - [ ] I have read the [CONTRIBUTING.md guide](https://github.com/esp-rs/esp-hal/blob/main/documentation/CONTRIBUTING.md) and followed its instructions. diff --git a/README.md b/README.md index 3a4e0a50a4..6bb4dac69a 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ When browsing the examples, we recommend viewing the tag for the `esp-hal` relea We have a number of living documents to aid contributing to the project, please give these a read before modifying code: -- [API-GUIDELINES](https://github.com/esp-rs/esp-hal/blob/main/documentation/API-GUIDELINES.md) +- [DEVELOPER-GUIDELINES](https://github.com/esp-rs/esp-hal/blob/main/documentation/DEVELOPER-GUIDELINES.md) - [CONTRIBUTING-GUIDE](https://github.com/esp-rs/esp-hal/blob/main/documentation/CONTRIBUTING.md) ## License diff --git a/documentation/CONTRIBUTING.md b/documentation/CONTRIBUTING.md index 0ce91dd0dc..bbc36dcb9a 100644 --- a/documentation/CONTRIBUTING.md +++ b/documentation/CONTRIBUTING.md @@ -41,7 +41,7 @@ Before adding or changing code, review the [esp-rs API guidelines]. [Setting Up Git]: https://docs.github.com/en/get-started/quickstart/set-up-git [GitHub Flow]: https://docs.github.com/en/get-started/quickstart/github-flow [Pull Requests]: https://docs.github.com/en/github/collaborating-with-pull-requests -[esp-rs API guidelines]: ./documentation/API-GUIDELINES.md +[esp-rs developer guidelines]: ./documentation/DEVELOPER-GUIDELINES.md ## Getting Started @@ -140,4 +140,4 @@ This will use `rustfmt` to ensure that all source code is formatted correctly pr Congratulations! The `esp-rs` team thanks you for your contributions! -Contributing to open source extends beyond just code! Each contribution, regardless of size, plays a significant role. We appreciate your involvement in this collective endeavor. \ No newline at end of file +Contributing to open source extends beyond just code! Each contribution, regardless of size, plays a significant role. We appreciate your involvement in this collective endeavor.