[Short one-line description of the organization or project goes here.]

• About
• Getting Started
• Repository Structure
• Branching Strategy
• Contribution Guidelines
• Code Standards
• Commit Message Convention
• Pull Request Process
• Communication

Kranti Robotics is the robotics-focused identity of Kranti Associates Canada Limited, dedicated to [robotics / automation / embedded systems — fill in as appropriate].

This GitHub organization hosts all source code, documentation, and resources related to our engineering projects.

Follow these steps to get set up as a new member:

1. Accept the organization invitation sent to your GitHub email.
2. Enable two-factor authentication (2FA) on your GitHub account — this is mandatory for all members.
3. Clone the relevant repository:

   git clone https://github.com/kranti-robotics/<repo-name>.git
   cd <repo-name>

4. Install dependencies (see the individual repository's README.md for specific instructions).
5. Set up your local environment using the provided .env.example or configuration files.

⚠️ Never commit secrets, API keys, or credentials to any repository.

We follow a simplified Git Flow model:

Rules:

• Never push directly to main or develop.
• All changes must go through a Pull Request (PR).
• Branches should be deleted after merging.

1. Check the Issues tab before starting any work — pick up an existing issue or open a new one.
2. Assign yourself to the issue before starting.
3. Create a branch following the naming convention above.
4. Write clean, documented, and tested code.
5. Open a Pull Request and request at least one reviewer.
6. Address all review comments before merging.

• Follow the style guide relevant to the language (e.g., PEP 8 for Python, Google Style for C++).
• All functions and modules must include docstrings / header comments.
• Avoid commented-out code in commits.
• Keep functions small and single-purpose.
• Write unit tests for all new logic where applicable.

Use the following format for all commit messages:

<type>(<scope>): <short description>

[optional body]
[optional footer]

Types:

Example:

feat(arm-controller): add inverse kinematics solver

Implemented a Jacobian-based IK solver for the 6-DOF arm.
Closes #42

1. Ensure your branch is up to date with develop before opening a PR.
2. Fill in the PR template completely.
3. Link the relevant issue(s) using Closes #<issue-number>.
4. All CI checks must pass before a PR can be merged.
5. At least one approval is required from a reviewer.
6. The author should not merge their own PR unless explicitly authorized.

This README is a living document. Members are encouraged to suggest improvements via a Pull Request.