Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tabacitu committed Feb 6, 2017
1 parent 97b044f commit 0773d81
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ No documentation can be 100% complete and Backpack's is no different, sorry for

**[Open an issue](https://github.com/laravel-backpack/crud) 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](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer). It's ok to push non-PSR-2 code, but know that [StyleCI](https://styleci.io/) will convert it after the merge.

# Discovered a bug?

**Step 1. [Open an issue](https://github.com/laravel-backpack/crud).** Please include:
Expand All @@ -25,11 +31,7 @@ If you have a solution for it and want to help, you can submit a Pull Request. T
- you'll become one of the Backpack contributors; [welcome to the party! :-)](https://media.giphy.com/media/l0MYt5jPR6QX5pnqM/giphy.gif);
- 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](https://mattstauffer.co/blog/how-to-contribute-to-an-open-source-github-project-using-your-own-fork) and the rules below. I promise, you'll actually enjoy sending PRs after a while :-)

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

- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer). It's ok to push non-PSR-2 code, but know that [StyleCI](https://styleci.io/) will convert it after the merge.
If you've never submitted a PR before, don't worry, it's not that difficult. Read [this tutoral](https://mattstauffer.co/blog/how-to-contribute-to-an-open-source-github-project-using-your-own-fork) and the rules above. I promise, you'll enjoy sending PRs after a while :-)


# Want to help out?
Expand Down

0 comments on commit 0773d81

Please sign in to comment.