# Laravel Notification Channels

We aim to provide a curated selection of notification channels for use in your Laravel applications. Please use the sidebar on the left to find the appropriate package for you needs. If we don't have a package for your desired service yet, read on for instructions on how to contribute!

# Suggesting a new Channel

Please create an issue in the channels repo (opens new window) for your suggestion. Include links to the API documentation and provider's site.

# Contributing

If you'd like to add a custom driver to the list, please download our skeleton repo (opens new window), and open a new Pull Request on our channels repo (opens new window).

Contributions are welcome and will be fully credited.

Please read and understand the FAQ below before creating an issue or pull request.


# How can I get support?

If you need help with anything, you can create an issue on github. If the issue relates to a specific channel, you should create the issue it that repository. There's a link at the top of each documentation page to the channel's github repository. A list of all the repos can be found here (opens new window).

If you have questions about the project in general, please create an issue in the channels repo (opens new window)

If you have found a security issue in one of the channels, try to contact the maintainer using the email in the channel's readme. If you can't get in contact with them, please email atymicq@gmail.com and I'll address the issue.

# Who owns the work?

It is up to the package author to maintain the repository after it has been released.

You'll be given admin rights to your repo. So you are in total control. Only if you ever do something like breaking semver we'll step in.

You'll also be added to the Laravel Notification Channels github organization (which shows up on your github profile).

If some problems should arise you're always free to copy over the code to your own repo and abandon the one in our organization.

# What level of access is given?

Admin Rights & membership of the github organisation.

# What happens to the package, if the author decides to abandon or quit?

We, as a community, will step in until we find a replacement.

# What rights are being taken away from the author automatically?


# What are their rights as an author?

Technically: Admin rights, and you may do with the code whatever your want.

# Who decides who can be part of the package as a collaborator?

As an admin, package maintainers can choose their own collaborators.

# What are the rules?

You're reading them. If we have the same values (creating a good experience for the users) we don't need too many rules.

# What are the benefits?

For package users: an excellent experience

For package creators: a small ecosystem of package creators that can help each other

# Etiquette

These projects are open source, and as such, the maintainers give their free time to build and maintain the source code held within. They make the code freely available in the hope that it will be of use to other developers. It would be extremely unfair for them to suffer abuse or anger for their hard work.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the world that developers are civilized and selfless people.

It's the duty of the maintainer to ensure that all submissions to the project are of sufficient quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.

# Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many developers, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.

# Procedure

Before filing an issue:

  • Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
  • Check to make sure your feature suggestion isn't already present within the project.
  • Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
  • Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:

  • Check the codebase to ensure that your feature doesn't already exist.
  • Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

# Requirements

If the project maintainer has any additional requirements, you will find them listed here.

  • PSR-2 Coding Standard (opens new window) - The easiest way to apply the conventions is to install PHP Code Sniffer (opens new window).

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • Consider our release cycle - We try to follow SemVer v2.0.0 (opens new window). Randomly breaking public APIs is not an option.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them (opens new window) before submitting.

# Branding

The logo was designed by irazasyed (opens new window)
You can find high quality SVG & PNG versions below.

Type Preview Download Link
PNG Laravel-Notification-Channels-Logo.png (opens new window)
SVG Laravel-Notification-Channels-Logo.svg (opens new window)