From 9df1c07b1fb227ce15c1b6367aa8e33b9d16a773 Mon Sep 17 00:00:00 2001 From: Jesse Donat Date: Fri, 20 Feb 2015 15:52:52 -0600 Subject: [PATCH] Rough contributing doc added --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e08fd7d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# How to Contribute + +## Reporting Issues + +Issues can be reported via the [Github Issues](https://github.com/donatj/PhpUserAgent/issues) page. + +- **Detail is key**: If a browser is being misidentified, one or more sample user agent strings are key to getting it resolved. +- **Missing Browser**: Is it modern? What is it being misidentified as? There are a lot of dead browsers out there that there is no reason to support. + +Please do not file any requests for OS identification. + +## Pull Requests + +Pull requests are truly appreciated. While I try my best to stay on top of browsers hitting the market it is still a difficult task. + +- **Formatting**: Indentation **must** use tabs. Please try to match internal formatting and spacing to existing code. +- **Tests**: If you're adding support for a new browser be sure to add test user agents for if at all possible ***every platform*** the browser is available on. Untested code will take much longer to be merged. +- **Terseness**: Try to be terse. Be clever. Take up as little space as possible. The point of this project initially was to be smaller than the other guys. \ No newline at end of file