Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 2.38 KB
Raw

Contributing to Laravel Self Updater

Thank you for considering contributing to the Laravel Self Updater project! We appreciate your interest and help in improving our package. This document outlines how you can contribute to the project effectively.

How to Contribute

  1. Fork the Repository
    Click on the “Fork” button at the top right corner of the repository page to create your own copy of the project.

  2. Clone Your Fork
    Clone your forked repository to your local machine using the command:

    git clone https://github.com/your-username/laravel-self-updater.git

  3. Create a New Branch
    Create a new branch for your feature or bug fix:

    git checkout -b feature/your-feature-name

  4. Make Your Changes
    Implement your changes, ensuring they align with the existing code style and conventions.

  5. Write Tests
    If applicable, add tests for your changes to ensure functionality works as intended.

  6. Commit Your Changes
    Commit your changes with a clear and descriptive message:

    git commit -m "Add a concise description of your changes"

  7. Push to Your Fork
    Push your changes to your forked repository:

    git push origin feature/your-feature-name

  8. Create a Pull Request
    Navigate to the original repository and click on the "New Pull Request" button. Select your branch and submit the pull request, detailing the changes made and their importance.

Code Style

  • Follow the existing code style and conventions.
  • Write clear, concise commit messages.
  • Maintain comprehensive documentation for any new features or updates.

Reporting Issues

If you find any bugs or issues, please report them by opening an issue in this repository. Provide a detailed description of the problem, steps to reproduce it, and any relevant error messages or screenshots.

Documentation

Ensure that any changes you make are reflected in the documentation, particularly in the README.md or any relevant sections of the project documentation.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Contact

For questions or suggestions, feel free to reach out to the maintainers at [email protected].

Thank you for your contributions!