summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRich Leland <rich.leland@messagesystems.com>2015-07-02 16:58:24 -0400
committerRich Leland <rich.leland@messagesystems.com>2015-07-02 16:58:24 -0400
commitfe0732983c7735b653681d904c958285d0c88fb9 (patch)
tree717627ce845e15876b1b135e14c6015a5f4d21ce
parentff0e8f5f4bfe69d330e2e5a86b3caa0a7ccb55c0 (diff)
downloadphp-sparkpost-fe0732983c7735b653681d904c958285d0c88fb9.zip
php-sparkpost-fe0732983c7735b653681d904c958285d0c88fb9.tar.gz
php-sparkpost-fe0732983c7735b653681d904c958285d0c88fb9.tar.bz2
Updated contributing section. Refs #2.
-rw-r--r--AUTHORS.md6
-rw-r--r--README.md11
2 files changed, 11 insertions, 6 deletions
diff --git a/AUTHORS.md b/AUTHORS.md
new file mode 100644
index 0000000..18626c5
--- /dev/null
+++ b/AUTHORS.md
@@ -0,0 +1,6 @@
+php-sparkpost is maintained by Message Systems.
+
+# Contributors
+
+* Jordan Nornhold <jordan.norhold@messagesystems.com>
+* Rich Leland <rich.leland@messagesystems.com>, @richleland
diff --git a/README.md b/README.md
index 9d8258a..7df4c48 100644
--- a/README.md
+++ b/README.md
@@ -97,10 +97,9 @@ Once all the dependencies are installed, you can execute the unit tests using `v
If you're interested in code coverage, you can add the `--coverage` flag for phpunit like so: ```phpunit --coverage-html test/output/report --bootstrap test/unit/bootstrap.php ./test/unit```
### Contributing
-Guidelines for adding issues
+1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a `Contributor Friendly`_ tag for issues that should be ideal for people who are not very familiar with the codebase yet.
+2. If you feel uncomfortable or uncertain about an issue or your changes, feel free to email @sigmavirus24 and he will happily help you via email, Skype, remote pairing or whatever you are comfortable with.
+3. Fork [the repository](http://github.com/SparkPost/php-sparkpost) on GitHub to start making your changes to the **master** branch (or branch off of it).
+4. Write a test which shows that the bug was fixed or that the feature works as expected.
+5. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to [AUTHORS](https://github.com/SparkPost/php-sparkpost/blob/master/AUTHORS.md).
-Submitting pull requests
-
-Signing our CLA
-
-Our coding standards