Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 2.63 KB

CONTRIBUTING.rst

File metadata and controls

36 lines (25 loc) · 2.63 KB
Raw

Support & Contribution Guidelines

Please submit support requests, bug reports, feature requests and pull requests using GitHub issues.

All support requests / bug reports should include the following:

  • The complete error message, including file & line numbers
  • Steps to reproduce the problem
  • Laravel Breadcrumbs version
  • Laravel version
  • PHP version

You should also include copies of the following where appropriate:

  • app/Http/breadcrumbs.php
  • config/breadcrumbs.php (if used)
  • The view or layout that outputs the breadcrumbs
  • The custom breadcrumbs template (if applicable)
  • The providers and aliases sections of config/app.php (Note: not the Encryption Key section which should be kept private) -- in case there's a conflict with another package
  • Any other relevant files

Note: Don't be afraid to go into the Laravel Breadcrumbs code and use var_dump() (or print_r()) to see what's happening and try to fix your own problems! A pull request or detailed bug report is much more likely to get attention than a vague error report. Also make sure you read the documentation carefully.

Any feature requests / pull requests should include details of what you are trying to achieve (use case) to explain why your request should be implemented.

If you want to submit a bug fix, please make your changes in a new branch, then open a pull request. (The Contributing page of the docs may help you to get started if you've not done this before.)

If you want to submit a new feature, it's usually best to open an issue to discuss the idea first -- to make sure it will be accepted before spending too much time on it. (Of course you can go ahead and develop it first if you prefer!) Please be sure to update the documentation as well.

If you have any suggestions for improving the documentation -- especially if anything is unclear to you and could be explained better -- please let me know. (Or just edit it yourself and make a pull request.)