Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 2.4 KB
Raw

Contributing to Awesome Pulse

Thank you for your interest in contributing to Awesome Pulse! This document provides guidelines for contributing to this curated list of Laravel Pulse packages.

How Can I Contribute?

Suggesting a Laravel Pulse Package

If you know of a Laravel Pulse package that isn't already on the list but should be, your suggestions are welcome!

Before Suggesting a Package

  • Ensure the package is compatible with the latest version of Laravel Pulse.
  • Check if the package is already listed. Duplicate suggestions can be counterproductive.
  • Verify the quality of the package. It should be well-maintained, documented, and widely used or innovative in its utility.

How Do I Suggest a Package?

Submit your suggestion as a GitHub issue. In the issue, please include:

  • The name of the package and a link to its repository or page.
  • A brief description of the package and why it's valuable to the Laravel Pulse community.
  • Any personal experience you have with using the package, if applicable.

Updating Information

If you find that information about a package is outdated or incorrect, please let us know.

  • Create a GitHub issue, specifying what information is outdated or incorrect.
  • Provide the correct or updated information, if possible.
  • Include a link to your source of the new information.

Documentation and Miscellaneous Contributions

Improvements to documentation, README, or any other files in this repository are equally welcome. If you spot typos, grammatical errors, or unclear explanations, feel free to submit a pull request or open an issue.

Pull Request Process

  • Fork the repository and create your branch from master.
  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md or relevant documentation with details of changes, this includes new environment variables, useful file locations, etc.
  • Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. Adhering to Semantic Versioning.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the reviewer to merge it for you.

Questions or Comments?

Feel free to open an issue in this repository if you have any questions or comments about contributing. Thanks again!