PR_GUIDELINES.md

Pull Request Guidelines

To contribute to this project, please follow these guidelines when creating pull requests (PRs):

Creating a Pull Request

1. Branch from main:

   • Create a new branch for your changes. Use descriptive branch names, e.g., feature/add-login or bugfix/fix-login-issue.

2. Commit Changes:

   • Make commits with clear, descriptive messages. Follow the format: [Type] Short description, where Type can be Feature, Fix, Docs, etc.

3. Push Branch:

   • Push your branch to the repository.

4. Open a Pull Request:

   • Go to the "Pull requests" tab and click "New pull request."
   • Select your branch and compare it with the main branch.
   • Provide a clear title and description of your changes.

Review Process

• Assign Reviewers: Add reviewers who will review your PR.

• Address Feedback: Respond to comments and make necessary changes.

• Approval and Merging: Once approved, the PR will be merged into main by a project maintainer.

Example Workflow

1. Create a Branch:

   git checkout -b feature/my-new-feature

2. Make Changes and Commit:

   git add .
   git commit -m "Feature: Add new login functionality"

3. Push and Create PR:

   git push origin feature/my-new-feature

4. Open PR on GitHub:

   • Go to "Pull requests" and follow the instructions to create a new PR.