Rihal Developer Contribution Guide

Welcome to the Rihal development team! This guide will help you navigate through the process of contributing to our projects effectively.

Onboarding

• Onboarding Documents: Ensure you review the Company Onboarding Document (Technical) which references all necessary existing documents.

Workflow

1. Project Setup

1. Follow the instructions in the Readme to set up the project on your local machine.
2. Install dependencies and ensure the app runs correctly.

2. Working with Issues & Branches

1. Review the list of GitHub issues. If no issue is assigned to you, request an assignment from your Lead.
2. Ensure your main branch is up to date by pulling from origin.
3. Create a new branch using the following naming convention:

<issue_number>-<short_description>
# Example: 123-add-login-page

1. Make your code changes in small, manageable commits.

3. Committing & Documentation

1. Commit your changes using the Conventional Commits specification.
2. Update any documentation impacted by your changes (README, API docs, etc.).

4. Rebasing & Pushing

1. Rebase your branch onto the latest main or develop branch.
2. Resolve any conflicts and push your branch to the remote repository.

5. Pull Request (PR) Process

1. Create a PR using the Repository Pull Request Template.
2. Fill out the template thoroughly.
3. Add appropriate labels based on the Rihal Labels Document.
4. Assign the PR to yourself and invite reviewers.
5. Wait for review — do not merge without approval.
6. Address all review feedback and make sure to mark the comments as resolved. Then re-request review so the reviewers get notified.
7. Once approved, perform a Squash Merge.
8. Delete the feature branch from the remote repository.

6. Reviewing Others’ PRs

1. Review PRs using the Rihal Code Review Checklist.
2. Leave constructive feedback and request changes if needed.
3. Test the code locally if necessary.
4. Approve only once the code meets quality and functional expectations.

Happy coding.