Skip to content

updated readme#2

Open
arjunkulkarni0208 wants to merge 1 commit intomainfrom
feat/doc
Open

updated readme#2
arjunkulkarni0208 wants to merge 1 commit intomainfrom
feat/doc

Conversation

@arjunkulkarni0208
Copy link
Contributor

@arjunkulkarni0208 arjunkulkarni0208 commented Feb 8, 2026

Description:

  • To make installation easier for post-workshop use case.

Related Issue:

Type of Change:

  • Bug fix
  • New feature
  • Documentation update
  • Configuration/Infrastructure (Ansible, Docker, CI/CD, build systems)
  • Refactoring (no functional changes)
  • Performance improvement

How Has This Been Tested?

Testing Status:

  • Robot tested (full integration on actual robot)
  • Bench tested (hardware components/modules tested on table)
  • Locally verified (script/playbook/model runs as expected on dev machine)
  • Simulation tested (Gazebo/RViz/MATLAB Simulink/custom sim)
  • Builds successfully but not functionally tested yet (explain reason below)

Testing Details:

Screenshots/Evidence (if appropriate):

Breaking Changes & Migration:

What breaks:

How to fix it:

Checklist (Assignee):

  • PR tackles a single feature/issue (not mixing multiple unrelated changes)
  • No unnecessary changes unrelated to this PR
  • Added comments for complex logic, TODOs, non-obvious decisions
  • Code compiles/builds without errors or warnings
  • Tested according to "Testing Status" section above
  • Documentation updated if needed (README, wiki, inline docs)
  • Evidence uploaded (rosbags/videos/screenshots/logs as appropriate)
  • Added correct PR labels (enhancement, bug, embedded, ros, perception, ansible, docker, matlab, web, etc.)
  • No commented code blocks (use git history instead)
  • Code follows team style guide and naming conventions

Checklist (Reviewer):

  • Verified all Assignee checks above
  • Code is well-organized, readable, and follows team standards
  • Documentation is clear and sufficient
  • Testing evidence reviewed (rosbags/videos/logs match claimed behavior)
  • Changes tested/verified according to "Testing Status" section
  • No obvious bugs, edge cases, or safety issues
  • For infrastructure/deployment changes: rollback procedure is safe and clear

@arjunkulkarni0208 arjunkulkarni0208 self-assigned this Feb 8, 2026
@arjunkulkarni0208 arjunkulkarni0208 added the documentation Improvements or additions to documentation label Feb 8, 2026
@arjunkulkarni0208 arjunkulkarni0208 removed the request for review from Samyy7 February 8, 2026 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant