Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 3.71 KB

CONTRIBUTING.md

File metadata and controls

78 lines (53 loc) · 3.71 KB
Raw

Contributing to Laravel Starter Project

Thank you for your interest in contributing to the Laravel Starter Project! Whether you want to report issues, suggest new features, or contribute code changes, your participation is highly appreciated. Please take a moment to review this guide before getting started.

Table of Contents

Code of Conduct

Before contributing, please review and adhere to our Code of Conduct. We expect all contributors to maintain a respectful and inclusive environment.

Reporting Issues

If you encounter bugs, issues, or unexpected behavior in the Laravel Starter Project, please check the existing issues on GitHub to see if it's already reported. To submit a new issue:

  1. Go to the Issues section.
  2. Click on the "New Issue" button.
  3. Select the appropriate issue template (bug report, feature request, etc.).
  4. Provide clear and concise details about the problem or suggestion.

Our team will review the issue and respond promptly. Please be patient and offer additional information if required.

Feature Requests

We encourage you to share ideas and request new features for the Laravel Starter Project:

  1. Go to the Issues section.
  2. Click on the "New Issue" button.
  3. Choose the "Feature Request" template.
  4. Describe the feature you propose, offering as much context as possible.

Upon review, if your feature aligns with the project goals, it may be added to our development roadmap.

Development Setup

To set up the development environment for the Laravel Starter Project:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Install dependencies by running composer install and npm install in the project root folder.
  4. Configure the .env file for your database connection.
  5. Run database migrations with php artisan migrate and seed the database with php artisan db:seed.
  6. Start the development server using php artisan serve.

Creating Pull Requests

Contributions in the form of code changes or bug fixes are appreciated. Here's how to submit a pull request (PR):

  1. Create a new branch based on the develop branch with a descriptive name (e.g., feature/new-feature or bugfix/issue-123).
  2. Implement your changes, ensuring adherence to the coding guidelines.
  3. Commit your changes with clear and concise messages.
  4. Push your branch to your forked repository on GitHub.
  5. Open a pull request (PR) against the main branch of the original repository.
  6. Provide a detailed description of your changes and the problem they address in the PR description.

Our team will review your PR, provide feedback if needed, and merge it once it meets our standards.

Coding Guidelines

To maintain code consistency and readability, follow these guidelines:

  • Use meaningful variable and function names.
  • Adhere to the existing coding style, including indentation and formatting.
  • Add comments, especially in complex sections, to enhance understanding.
  • Write clear and concise commit messages, explaining each commit's purpose.

License

By contributing to the Laravel Starter Project, you agree that your contributions will be licensed under the MIT License.