From b63803e8efb30668eaa6681dbc8b404ff56fd700 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Mon, 13 May 2019 20:42:09 +0200 Subject: [PATCH] Fix missing dir --- .../mobiledetectlib/docs/CONTRIBUTING.md | 48 +++++++++++++++++++ .../mobiledetectlib/docs/HISTORY.md | 11 +++++ .../mobiledetectlib/docs/ISSUE_TEMPLATE.md | 15 ++++++ .../mobiledetectlib/docs/KNOWN_LIMITATIONS.md | 11 +++++ 4 files changed, 85 insertions(+) create mode 100644 htdocs/includes/mobiledetect/mobiledetectlib/docs/CONTRIBUTING.md create mode 100644 htdocs/includes/mobiledetect/mobiledetectlib/docs/HISTORY.md create mode 100644 htdocs/includes/mobiledetect/mobiledetectlib/docs/ISSUE_TEMPLATE.md create mode 100644 htdocs/includes/mobiledetect/mobiledetectlib/docs/KNOWN_LIMITATIONS.md diff --git a/htdocs/includes/mobiledetect/mobiledetectlib/docs/CONTRIBUTING.md b/htdocs/includes/mobiledetect/mobiledetectlib/docs/CONTRIBUTING.md new file mode 100644 index 00000000000..01a266ed83c --- /dev/null +++ b/htdocs/includes/mobiledetect/mobiledetectlib/docs/CONTRIBUTING.md @@ -0,0 +1,48 @@ +**Reporting issues** + +1. Specify the User-agent by visiting [http://demo.mobiledetect.net](http://demo.mobiledetect.net). +1. Specify the expected behaviour. + +**Developing** + +1. Fork Mobile Detect repository. See ["How to fork"](https://help.github.com/articles/fork-a-repo/#fork-an-example-repository) example. +1. `git clone https://github.com/[yourname]/Mobile-Detect.git` +1. `git add remote serbanghita https://github.com/serbanghita/Mobile-Detect.git` +1. `git remote -v` - You should see: + ``` + origin git@github.com:serbanghita/Mobile-Detect.git + serbanghita https://github.com/serbanghita/Mobile-Detect.git + ``` +1. `git checkout -b devel origin/devel` +1. `composer install` +1. Start working on your changes. + 1. If you add new methods or make structural changes to the `Mobile_Detect.php` class + you need to add unit tests! + 1. If you add new regexes make sure you commit the User-Agents in [`tests/providers/vendors`](https://github.com/serbanghita/Mobile-Detect/tree/master/tests/providers/vendors) +1. Run tests `vendor/bin/phpunit -v -c tests/phpunit.xml --coverage-text --strict-coverage --stop-on-risky` +1. `git status` or `git diff` - inspect your changes +1 `git stage .` +1. `git commit -m "[your commit message here]` +1. `git push origin devel` +1. Go to your repo on GitHub and ["Submit the PR"](https://help.github.com/articles/about-pull-requests/) + +**New module, plugin, plugin or port** + +[Submit new module, plugin, port](../../issues/new?title=New%203rd%20party%20module&body=Name,%20Link%20and%20Description%20of%20the%20module.) + including the following information: +* Module name +* Description +* Link +* Author + +Or you can submit a PR against `README.md`. + +**Website updates** + +1. Our official website is hosted at [http://mobiledetect.net](http://mobiledetect.net). +1. The files are found on the `gh-pages` branch. +1. `git checkout gh-pages` +1. `npm install -g browser-sync` +1. `browser-sync start --s . --f . --port 3000 --reload-debounce 1500 --no-ui` +1. Go to `http://localhost:3000` and make changes. +1. Commit, push and submit the PR against `serbanghita:gh-pages`. \ No newline at end of file diff --git a/htdocs/includes/mobiledetect/mobiledetectlib/docs/HISTORY.md b/htdocs/includes/mobiledetect/mobiledetectlib/docs/HISTORY.md new file mode 100644 index 00000000000..3483985258e --- /dev/null +++ b/htdocs/includes/mobiledetect/mobiledetectlib/docs/HISTORY.md @@ -0,0 +1,11 @@ +The first version of the script was developed in 2009 and it was hosted at https://code.google.com/p/php-mobile-detect/, it was a small project with around 30 stars. (Original blog post by Victor: http://victorstanciu.ro/detectarea-platformelor-mobile-in-php/) + +In December 2011 it received a major update from the first version, an important number of issues were fixed, then 2.0 was launched. The new version marks a new mindset and also featuring tablet detection. + +Throughout 2012 the script has been updated constantly and we have received tons of feedback and requests. + +In July 2012 we moved the repository from Google Code to GitHub in order to quickly accommodate the frequent updates and to involve more people. + +In August 2013 the library has 1800+ stargazers and support for: composer, PHPUnit tests, PSR standards and a new webpage http://mobiledetect.net + +Mobile Detect library and user contributions are MIT Licensed. diff --git a/htdocs/includes/mobiledetect/mobiledetectlib/docs/ISSUE_TEMPLATE.md b/htdocs/includes/mobiledetect/mobiledetectlib/docs/ISSUE_TEMPLATE.md new file mode 100644 index 00000000000..8d6384fce89 --- /dev/null +++ b/htdocs/includes/mobiledetect/mobiledetectlib/docs/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ +-------------delete this message------------- +* By submitting a new issue I acknowledge that I already read the README, CODE EXAMPLES and KNOWN LIMITATIONS. +* I understand that the current version `2.x` is only meant to detect `mobile` devices. +* Please post your User-Agent string! On a real device/s, the library is expected to work correctly. +-------------delete this message------------- + + + +**Issue description** + + +**User-Agent(s)** + + +**Suggestions** \ No newline at end of file diff --git a/htdocs/includes/mobiledetect/mobiledetectlib/docs/KNOWN_LIMITATIONS.md b/htdocs/includes/mobiledetect/mobiledetectlib/docs/KNOWN_LIMITATIONS.md new file mode 100644 index 00000000000..8b5d461fe38 --- /dev/null +++ b/htdocs/includes/mobiledetect/mobiledetectlib/docs/KNOWN_LIMITATIONS.md @@ -0,0 +1,11 @@ +**Known limitations** + +* Mobile Detect script was designed to detect `mobile` devices. Implicitly other devices are considered to be `desktop`. +* User-Agent and HTTP headers sniffing is a non reliable method of detecting a mobile device. +* If the mobile browser is set on `Desktop mode`, the Mobile Detect script has no way of knowing that the device is `mobile`. +* Some touchscreen devices (eg. Microsoft Surface) are tough to detect as mobile since they can be used in a laptop mode. +* Detecting the device brand (eg. Apple, Samsung, HTC) is not 100% reliable. +* We don't monitor the quality of the 3rd party tools based on Mobile Detect script. +We cannot guarantee that they are using the class properly or if they provide the latest version. +* Version `2.x` is made to be PHP 5.3 compatible because of the backward compatibility changes of PHP. +* There are hundreds of devices launched every month, we cannot keep a 100% up to date detection rate. \ No newline at end of file