> For the complete documentation index, see [llms.txt](https://carec.gitbook.io/carec-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://carec.gitbook.io/carec-docs/documentation/team-hub.md). # Team Hub Welcome to the CAREC engineering team. **Start here before making your first contribution.** This is the single directory for where work lives, how to contribute, and which actions require approval. > **Project owner:** `vinodkumar1947`. For **any elevated permission, restricted access, or owner-controlled approval request**, contact `vinodkumar1947`. > **Safety first:** Do not test experimental motion or autonomy changes with a person in the wheelchair. Safety-related review is a blocking requirement. ## Quick links | I need to… | Go here | | -------------------------------- | -------------------------------------------------------------------------- | | Understand CAREC | Project Overview | | Access source code | [CAREC GitHub repository](https://github.com/vinodkumar1947/CAREC-Project) | | Read engineering documentation | CAREC Documentation | | Start without hardware | Contribute Without Hardware | | Set up simulation | Simulation Quickstart | | Understand the system | System Architecture | | Learn development setup | Development Environment | | Understand safety | [Safety](/carec-docs/documentation/safety.md) | | Learn the PR workflow | Issue and Pull-Request Workflow | | Request elevated access/approval | Access & Approval Guide | | See project direction | [Roadmap](/carec-docs/documentation/roadmap.md) | ## New member — first 30 minutes * [ ] Read the Project Overview. * [ ] Open the [public CAREC repository](https://github.com/vinodkumar1947/CAREC-Project) and review its README and issues. * [ ] Clone or fork the repository — no permission is required to read, clone, fork, open issues, or submit pull requests. * [ ] Read Safety Principles and Operating Domain. * [ ] Choose a Contribution Track. * [ ] Without hardware, begin with Contribute Without Hardware and Simulation Quickstart. * [ ] Select a defined issue or ask `vinodkumar1947` for an assignment before substantial work. ## Where things live ### GitHub — code and engineering work **Repository:** [vinodkumar1947/CAREC-Project](https://github.com/vinodkumar1947/CAREC-Project) The CAREC repository is **public**. Anyone may view, clone, fork, open issues, and submit pull requests without requesting repository access. Contact project owner `vinodkumar1947` only when you need elevated permissions such as collaborator/write access, repository settings access, release authority, or another restricted capability. Use GitHub for source code, branches, issues, pull requests, reviews, tests, and implementation history. ### GitBook — engineering knowledge Use GitBook for onboarding, architecture, autonomous mobility, simulation, hardware, software, safety, development procedures, contributor guidance, research, reference material, and roadmap. **Rule of thumb:** GitHub answers **“what changed?”** GitBook answers **“how CAREC is designed and how the team works.”** ## Contribution flow **Issue → Scope → Branch → Implement → Test/Evidence → Pull Request → Review → Approval → Merge** 1. Select or create an issue. 2. Confirm scope, interfaces, acceptance criteria, and safety impact. 3. Work on a focused branch; do not develop directly on `main`. 4. Add tests and reproducible evidence. 5. Open a pull request linked to the issue. 6. Address technical, safety, and documentation review. 7. Merge only after required checks and approvals pass. ## Access & approval at a glance | Request/change | Approval path | | ----------------------------- | ------------------------------------------------------ | | View/clone/fork repository | No permission required | | Open issue or submit PR | No permission required | | Collaborator/write access | Contact `vinodkumar1947` | | GitBook edit access | Contact `vinodkumar1947` | | Repository/admin permission | Contact `vinodkumar1947` | | Normal code contribution | PR review under project workflow | | New feature | Issue/scope agreement | | Architecture/interface change | Technical review → `vinodkumar1947` | | Safety-related behavior | Safety + technical review → `vinodkumar1947`; blocking | | Merge/release authority | `vinodkumar1947` | | Hardware experiment | `vinodkumar1947`; safety review when applicable | See Access & Approval Guide for details. ## Changes requiring special review Motor commands, braking/stopping, emergency stop, manual takeover, obstacle avoidance, collision detection, autonomous navigation, power safety, sensor-failure behavior, and other user-affecting behavior require explicit safety consideration. Start with [Safety](/carec-docs/documentation/safety.md) and Hazard Analysis. ## Remote contributors Hardware is not required for many useful contributions. Prioritize simulation, ROS 2/software modules, perception, test automation, datasets/tooling, documentation, research, CI, and isolated firmware/software components. ## Weekly coordination CAREC uses one weekly engineering coordination meeting for introductions, project context, contribution needs, task assignment/progress, and Q\&A. Invitations are shared with confirmed contributors. Use GitHub issues and PRs for engineering decisions that need a durable record. ## Need help? Start with the relevant GitBook section. If the answer is not documented, ask on the associated GitHub issue or contact project owner `vinodkumar1947`. For **elevated permission, restricted access, release, safety-critical approval, or hardware-related requests**, contact `vinodkumar1947` directly. Next: read the Contributor Handbook. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://carec.gitbook.io/carec-docs/documentation/team-hub.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.