Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

65 lines (48 loc) · 2.86 KB

Welcome

Thank you for considering contributing to our project! We appreciate your time and effort in helping us improve.

Introduction

This document outlines the process for contributing to our Laravel and Flutter projects. Please follow the guidelines below to ensure a smooth contribution process.

Contributing to Laravel Projects

External Contributors

  1. Fork the repository and clone it locally.
  2. Create a new branch for your feature or bugfix.
  3. Install the dependencies using composer install.
  4. (Optional) Update packages to the latest version using composer update.
  5. Make your changes and ensure the tests pass using composer test.
  6. Commit your changes with a descriptive commit message.
  7. Push your branch to your fork and submit a pull request.

Internal Contributors

  1. Clone the repository locally.
  2. Create a new branch for your feature or bugfix.
  3. Install the dependencies using composer install.
  4. (Optional) Update packages to the latest version using composer update.
  5. Make your changes and ensure the tests pass using composer test.
  6. Commit your changes with a descriptive commit message.
  7. Push your branch to the main repository and submit a pull request.

Contributing to Flutter Projects

External Contributors

  1. Fork the repository and clone it locally.
  2. Create a new branch for your feature or bugfix.
  3. Install the dependencies using flutter pub get.
  4. (Optional) Update packages to the latest version using flutter pub upgrade.
  5. Make your changes and ensure the tests pass using flutter test.
  6. Commit your changes with a descriptive commit message.
  7. Push your branch to your fork and submit a pull request.

Internal Contributors

  1. Clone the repository locally.
  2. Create a new branch for your feature or bugfix.
  3. Install the dependencies using flutter pub get.
  4. (Optional) Update packages to the latest version using flutter pub upgrade.
  5. Make your changes and ensure the tests pass using flutter test.
  6. Commit your changes with a descriptive commit message.
  7. Push your branch to the main repository and submit a pull request.

Coding Standards

  • Follow the PSR-12 coding standard for PHP code.
  • For Laravel projects, use the devanoxltd/laravel-revive package to ensure coding standards.
  • Follow the Effective Dart guidelines for Dart code.
  • Ensure your code is well-documented and includes comments where necessary.

Code Review Process

  1. Once you submit a pull request, it will be reviewed by one of our maintainers.
  2. The reviewer may request changes or ask questions about your code.
  3. Make the requested changes and update your pull request.
  4. Once the reviewer is satisfied, your pull request will be merged into the main branch.