Skip to content

Commit c6a4b56

Browse files
committed
docs: Update docs on unify workspace style
1 parent 6fb6f3b commit c6a4b56

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- Open and self-assign a GitHub issue before starting.
3030
- Branch naming: `feat/<name>` or `fix/<name>`.
3131
- Commit messages must follow Conventional Commits and include rationale and sources when relevant.
32+
- When `template_ws` changes require syncing other workspaces, make a separate minimal "unify" commit (preferred message: `feat: Unify workspaces style`).
3233
- If code/content is copied, include source and commit permalink in the commit message.
3334
- Add `Co-authored-by` lines for contributors who helped; avoid force-pushes once review starts.
3435

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ We welcome all kinds of contributions, including but not limited to bug reports,
1919
2. Commit description should include as much details as possible. Try to include references you consulted and your rationale behind the changes. This will be essential for reviewers to understand the changes and for future reference. (e.g., [`058ff59`](https://github.com/j3soon/ros2-essentials/commit/058ff598ae705c95516353cd14a71945176c337e))
2020
3. If copied files from other sources, please include the source in the commit message. If copied from GitHub, include the permalink (link with commit ID) and the branch name. (e.g., [`6a2dac1`](https://github.com/j3soon/ros2-essentials/commit/6a2dac186e1321dc7f7ec961ad22628bffc352d3))
2121
4. Each commit should be atomic and self-contained.
22-
5. If anyone helped you during the development, please include them in the commit message using the `Co-authored-by` format (e.g., [`4f9832d`](https://github.com/j3soon/ros2-essentials/commit/4f9832d7a0c4156449d95b3503f9928d2d7de376) due to [this comment](https://github.com/j3soon/ros2-essentials/pull/85#discussion_r2204978905)). These include, but are not limited to, feedback from reviewers, in-person discussions, and pair programming sessions.
23-
6. Refrain from force-pushes after a reviewer has started reviewing your changes. The only exception is for new contributors when a reviewer has explicitly asked you to rebase your branch or modify commit messages.
24-
7. Use USDA instead of USD file format whenever possible for better readability and version control. (e.g., [PR#101](https://github.com/j3soon/ros2-essentials/pull/101))
22+
5. When updating `template_ws` defaults, follow up with a separate unify workspace style commit (preferred message: `feat: Unify workspaces style`) that applies the minimal template-alignment changes across all workspaces. Keep this separate from the template update commit.
23+
6. If anyone helped you during the development, please include them in the commit message using the `Co-authored-by` format (e.g., [`4f9832d`](https://github.com/j3soon/ros2-essentials/commit/4f9832d7a0c4156449d95b3503f9928d2d7de376) due to [this comment](https://github.com/j3soon/ros2-essentials/pull/85#discussion_r2204978905)). These include, but are not limited to, feedback from reviewers, in-person discussions, and pair programming sessions.
24+
7. Refrain from force-pushes after a reviewer has started reviewing your changes. The only exception is for new contributors when a reviewer has explicitly asked you to rebase your branch or modify commit messages.
25+
8. Use USDA instead of USD file format whenever possible for better readability and version control. (e.g., [PR#101](https://github.com/j3soon/ros2-essentials/pull/101))
2526

2627
Use `git log` and search for related commits to understand the commit message format.
2728

0 commit comments

Comments
 (0)