Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 2.82 KB
Raw

Having trouble using Backpack?

No documentation can be 100% complete and Backpack's is no different, sorry for that. There are plenty of people that follow the StackOverflow tag "backpack-for-laravel" and are glad to help you out. Post your question there and please include:

  • (A) what you did
  • (B) what you expected to happen
  • (C) what happened
  • (D) what have you already tried to fix it?

Idea for a new feature?

Open an issue and tell the community you are willing to submit a PR. We usually end up with better solutions when we talk about it and everybody pitches in with their opinion. Plus, some features might be better presented as a separate package, a tutorial or a code snippet.

PR Rules:

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

  • PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer. It's ok to push non-PSR-2 code, but know that StyleCI will convert it after the merge.

Discovered a bug?

Step 1. Open an issue. Please include:

  • (A) what you did
  • (B) what you expected to happen
  • (C) what happened
  • (D) what have you already tried to fix it?

Step 2. Submit a PR. If you have a solution for it and want to help, you can submit a Pull Request. Tell us you are willing to do that. It takes a little more time from you, but:

  • your fix is guaranteed to be merged a lot faster;
  • you'll become one of the Backpack contributors; welcome to the party! :-);
  • you'll not just be helping yourself and the maintainers of Backpack, you'd be helping thousants of Backpack developers;

If you've never submitted a PR before, don't worry, it's not that difficult. Read this tutoral and the rules above. I promise, you'll enjoy sending PRs after a while :-)

Want to help out?

Thank you, thank you, thank you! You can:

Happy coding!