This repository has been archived by the owner on Mar 12, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #38 from phergie/contributing
Add CONTRIBUTING.md based on discussion from #20
- Loading branch information
Showing
1 changed file
with
75 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
# Contributing to Phergie | ||
|
||
We welcome contributions. | ||
|
||
## Team members | ||
|
||
* [Matthew Turland](https://github.com/elazar) - original author and adviser | ||
* [Matthew Trask](https://github.com/rocketpastsix) - contributor, co-maintainer | ||
* [Joe Ferguson](https://github.com/svpernova09) - contributor, co-maintainer | ||
|
||
## Communication Channels | ||
|
||
You can find help and discussion in the following places: | ||
|
||
* Website: <http://phergie.org> | ||
* #phergie on Freenode: <https://webchat.freenode.net/?channels=phergie> | ||
* Github Issues: <https://github.com/phergie/phergie-irc-bot-react/issues> | ||
|
||
## Community | ||
|
||
The Phergie team believes heavily in the [PHP Mentoring](http://www.phpmentoring) project. | ||
We believe open source projects should be welcoming to newcomers and veteran contributors alike. | ||
We all actively work to provide a positive collaborative environment and to foster learning. | ||
|
||
## Project Breakdown | ||
|
||
The Phergie project is broken into different repositories for parts of the application. | ||
The core bot is in this repo. Plugins are in their own repositories. | ||
|
||
The Phergie team maintains many plugins under the Phergie organization while other contributors maintain their own plugins. | ||
|
||
## Have Questions? | ||
|
||
Feel free to open a issue on the appropriate repository, not sure? open an issue here. | ||
|
||
Join us on the Freenode IRC network in channel #phergie | ||
|
||
## Code Style | ||
|
||
We have adopted [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) as the primary style guide. | ||
|
||
We have a `.php_cs` configuration file for [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) | ||
|
||
We have also established a few style guidelines we strive for: | ||
|
||
* Four space indention | ||
* Methods, Properties, and Variables should be camelCase | ||
* Short array syntax | ||
* K&R braces (including elseif/else) | ||
* Chained method calls should be indented | ||
* See [Our Style Discussion](https://github.com/phergie/phergie-irc-bot-react/issues/20) For more. | ||
|
||
## Reporting Bugs | ||
|
||
Bugs are tracked in our project's [issue tracker](https://github.com/ramsey/uuid/issues). | ||
|
||
When submitting a bug report, please include enough information for us to reproduce the bug. A good bug report includes the following sections: | ||
|
||
* Expected outcome | ||
* Actual outcome | ||
* Steps to reproduce, including sample code | ||
* Any other information that will help us debug and reproduce the issue, including stack traces, system/environment information, and screenshots | ||
|
||
**Please do not include passwords or any personally identifiable information in your bug report and sample code.** | ||
|
||
## Fixing Bugs | ||
|
||
We welcome pull requests to fix bugs! | ||
|
||
If you see a bug report that you'd like to fix, please feel free to do so. Following the directions and guidelines described in the "Adding New Features" section below, you may create bugfix branches and send us pull requests. | ||
|
||
|
||
## Credit | ||
|
||
Thanks to [Ben Ramsey](https://github.com/ramsey) for sharing the awesome [ramesey/uuid contributing](https://github.com/ramsey/uuid/blob/master/CONTRIBUTING.md) document (that we blatantly copied large portions of). |