Skip to content

Commit 8a7752e

Browse files
authored
Add Readme Bindings Update Note (#188)
## 📔 Objective Add a note about not editing the `Cargo.toml` file when doing a bindings update PR. ## ⏰ Reminders before review - Contributor guidelines followed - All formatters and local linters executed and passed - Written new unit and / or integration tests where applicable - Protected functional changes with optionality (feature flags) - Used internationalization (i18n) for all UI strings - CI builds passed - Communicated to DevOps any deployment requirements - Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team ## 🦮 Reviewer guidelines <!-- Suggested interactions but feel free to use (or not) as you desire! --> - 👍 (`:+1:`) or similar for great changes - 📝 (`:memo:`) or ℹ️ (`:information_source:`) for notes or general info - ❓ (`:question:`) for questions - 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion - 🎨 (`:art:`) for suggestions / improvements - ❌ (`:x:`) or ⚠️ (`:warning:`) for more significant problems or concerns needing attention - 🌱 (`:seedling:`) or ♻️ (`:recycle:`) for future improvements or indications of technical debt - ⛏ (`:pick:`) for minor or nitpick changes
1 parent 0e49741 commit 8a7752e

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,12 @@ This project uses customized templates which lives in the `support/openapi-templ
9393
These templates resolves some outstanding issues we've experienced with the rust generator. But we
9494
strive towards modifying the templates as little as possible to ease future upgrades.
9595

96-
Note: If you don't have the nightly toolchain installed, the `build-api.sh` script will install it
97-
for you.
96+
### Note
97+
98+
- If you don't have the nightly toolchain installed, the `build-api.sh` script will install it for
99+
you.
100+
- This process also changes the `Cargo.toml` file. When creating a PR updating the bindings, please
101+
revert (do not include) the updates to the `Cargo.toml` file.
98102

99103
## Developer tools
100104

0 commit comments

Comments
 (0)