Thank you for your interest in contributing! To maintain a clean history and ensure a smooth development process, we follow a specific workflow. Please follow these guidelines to get started.
First, create your own copy of the repository by clicking the Fork button at the top of the page. Clone your fork to your local machine:
git clone https://github.com/YOUR-USERNAME/repository-name.git
cd repository-name
Add the original repository as a remote to keep your local fork in sync:
git remote add upstream https://github.com/ORIGINAL-OWNER/repository-name.git
Before starting any work, create a new branch. We use Conventional Naming based on the issue or ticket you are addressing:
feat/issue-ID(e.g.,feat/123-add- login-logic)fix/issue-ID(e.g.,fix/456-patch-security-hole)docs/issue-IDrefactor/issue-ID
git checkout -b feat/123-short-descriptionSee Conventional Commits.
Our repository uses a rebase flow to keep the history linear. When pulling updates from the main repository, always use the --rebase (or -r) flag to avoid merge commits:
git pull -r upstream main
We follow the Conventional Commits specification. Commits should be structured as follows:
<type>(<scope>): <description>
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
Example:
feat(auth): add JWT validation to login endpoint
See Conventional Commits.
Once you have completed your work and verified it locally:
- Push to your fork:
git push origin your-branch-name- Raise a PR: Navigate to the original repository on GitHub. You will see a prompt to "Compare & pull request" from your fork.
- Target Branch: Ensure your PR is targeting the
mainrepository'sdevormainbranch as specified in the issue. - Review: Wait for the maintainers to review your code. We may request changes before merging.
Thank you for helping us improve the project!