Skip to content

Conversation

hakuturu583
Copy link
Collaborator

@hakuturu583 hakuturu583 commented Jun 26, 2025

Description

Abstract

Add comprehensive project documentation (CLAUDE.md) with development commands, build instructions, and Git conventions to improve developer experience with claude code and maintain consistency across the project.

Background

The project lacked centralized documentation for development workflows, build commands, and conventions. This created inconsistency in how claude approach building, testing, and contributing to the codebase.

Details

This pull request introduces:

  1. CLAUDE.md documentation file:

    • Project structure overview and key components
    • Technology stack information (ROS 2, C++, OpenSCENARIO)
    • Comprehensive colcon build/test commands with package selection options
    • Formatting commands using ament_clang_format
    • Git conventions for commit messages and pull requests
  2. Updated .gitignore:

    • Added ros_workspace.txt to exclude workspace-specific configuration
  3. Workspace management system for Claude Code:

    • Environment-dependent ROS workspace path handling
    • Path to the workspace path was stored in ros_workspace.txt
    • Consistent build/test execution across different environments

References

N/A

Destructive Changes

N/A

Known Limitations

N/A

hakuturu583 and others added 2 commits June 26, 2025 12:46
- Add comprehensive project documentation in CLAUDE.md
- Include colcon build/test commands with package selection options
- Add workspace path management system
- Update .gitignore to exclude ros_workspace.txt

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Add pull request template guidelines and commit message standards

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Copy link

Checklist for reviewers ☑️

All references to "You" in the following text refer to the code reviewer.

  • Is this pull request written in a way that is easy to read from a third-party perspective?
  • Is there sufficient information (background, purpose, specification, algorithm description, list of disruptive changes, and migration guide) in the description of this pull request?
  • If this pull request contains a destructive change, does this pull request contain the migration guide?
  • Labels of this pull request are valid?
  • All unit tests/integration tests are included in this pull request? If you think adding test cases is unnecessary, please describe why and cross out this line.
  • The documentation for this pull request is enough? If you think adding documents for this pull request is unnecessary, please describe why and cross out this line.

- Add N/A requirement for optional PR template sections
- Fix LineLint compliance by adding newline at end of file

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@hakuturu583 hakuturu583 self-assigned this Jun 26, 2025
Include version bump label requirements for pull requests

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@hakuturu583 hakuturu583 marked this pull request as draft June 26, 2025 04:06
@hakuturu583 hakuturu583 added the bump patch If this pull request merged, bump patch version of the scenario_simulator_v2 label Jun 26, 2025
Copy link

@hakuturu583 hakuturu583 marked this pull request as ready for review June 26, 2025 05:51
@hakuturu583 hakuturu583 requested a review from HansRobo June 26, 2025 05:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bump patch If this pull request merged, bump patch version of the scenario_simulator_v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant