Skip to content

Latest commit

 

History

History
106 lines (81 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

106 lines (81 loc) · 2.94 KB

Contributing Guide

Thank you for considering contributing to BlogPost_PHP_Laravel! This guide will help you get started, whether you're fixing bugs, adding new features, or improving documentation.

Getting Started

  1. Fork the Repository

    • Start by forking this repository to your GitHub account.

  2. Clone the Forked Repository

    • Clone the repository to your local machine: 
      git clone https://github.com/your-username/BlogPost_PHP_Laravel.git
cd BlogPost_PHP_Laravel

  3. Set Up the Project Locally

    • Ensure you have the necessary dependencies installed:

      • PHP >= 8.0
      • Composer
      • Node.js & NPM

    • Install PHP dependencies:

      composer install

    • Install JavaScript dependencies:

      npm install && npm run dev

    • Copy the .env.example to .env and configure your environment variables:

      cp .env.example .env

    • Generate the application key:

      php artisan key:generate

    • Set up the database:

      • Update the .env file with your database configuration.
      • Run migrations to create tables: 
        php artisan migrate

  4. Run the Project

    • Start the development server:

      php artisan serve

    • Visit http://localhost:8000 in your browser to see the project.

Making Changes

  1. Create a Branch

    • Always create a new branch for your work: 
      git checkout -b feature/your-feature-name

  2. Make Your Changes

    • Make necessary changes, add your new feature, or fix any bugs.
    • Test your changes thoroughly to ensure they work as expected.

  3. Run Tests

    • If the project has tests, ensure all tests pass before submitting your code: 
      php artisan test

  4. Commit Your Changes

    • Write clear and descriptive commit messages: 
      git add .
git commit -m "Add feature: your feature description"

  5. Push to Your Fork

    • Push the branch to your forked repository: 
      git push origin feature/your-feature-name

  6. Open a Pull Request

    • Go to the original repository on GitHub and create a pull request (PR) from your branch.
    • In the PR description, provide details about what you’ve changed and any relevant information to help reviewers.

Guidelines

  • Code Style: Follow Laravel’s coding standards.
  • Commit Messages: Keep commit messages concise but informative.
  • PR Review: Be open to feedback, and update your PR as requested by reviewers.
  • Documentation: If your changes include new features, ensure you update or add to the documentation accordingly.

Need Help?

If you have any questions, feel free to open an issue or reach out in the discussions. We’re here to help!

Thank you for contributing! Your help in making this project better is greatly appreciated.