change gitignore
This commit is contained in:
@@ -0,0 +1,85 @@
|
||||
# Contributing to Mobile Detect
|
||||
|
||||
### License
|
||||
|
||||
By contributing to Mobile Detect library you agree with the [MIT License](../LICENSE) + contributing agreement below.
|
||||
|
||||
```
|
||||
Developer’s Certificate of Origin 1.1
|
||||
|
||||
By making a contribution to this project, I certify that:
|
||||
|
||||
(a) The contribution was created in whole or in part by me and I
|
||||
have the right to submit it under the open source license
|
||||
indicated in the file; or
|
||||
|
||||
(b) The contribution is based upon previous work that, to the best
|
||||
of my knowledge, is covered under an appropriate open source
|
||||
license and I have the right under that license to submit that
|
||||
work with modifications, whether created in whole or in part
|
||||
by me, under the same open source license (unless I am
|
||||
permitted to submit under a different license), as indicated
|
||||
in the file; or
|
||||
|
||||
(c) The contribution was provided directly to me by some other
|
||||
person who certified (a), (b) or (c) and I have not modified
|
||||
it.
|
||||
|
||||
(d) I understand and agree that this project and the contribution
|
||||
are public and that a record of the contribution (including all
|
||||
personal information I submit with it, including my sign-off) is
|
||||
maintained indefinitely and may be redistributed consistent with
|
||||
this project or the open source license(s) involved.
|
||||
```
|
||||
|
||||
### 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.
|
||||
2. `git clone https://github.com/[yourname]/Mobile-Detect.git`
|
||||
3. `git add remote serbanghita https://github.com/serbanghita/Mobile-Detect.git`
|
||||
4. `git remote -v` - You should see:
|
||||
```
|
||||
origin git@github.com:serbanghita/Mobile-Detect.git
|
||||
serbanghita https://github.com/serbanghita/Mobile-Detect.git
|
||||
```
|
||||
5. `git checkout -b devel origin/devel`
|
||||
6. `composer install`
|
||||
1. On Windows use `php composer.phar update` first.
|
||||
7. 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)
|
||||
8. Run tests
|
||||
9. `vendor/bin/phpunit -v -c tests/phpunit.xml --coverage-text --strict-coverage --stop-on-risky`
|
||||
1. On Windows use `%cd%/vendor/bin/phpunit ...`
|
||||
10. `git status` or `git diff` - inspect your changes
|
||||
1 `git stage .`
|
||||
11. `git commit -m "[your commit message here]`
|
||||
12. `git push origin devel`
|
||||
13. 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`.
|
||||
@@ -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 <a href="https://github.com/serbanghita/Mobile-Detect/blob/master/LICENSE.txt">MIT Licensed</a>.
|
||||
@@ -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**
|
||||
@@ -0,0 +1,15 @@
|
||||
**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 indicator (eg. a group of strings) that would allow it to detect that the device is `mobile`.
|
||||
* Ipad 2019 is being recognized as a desktop because of Safari's default `Request Desktop Website` setting. See details and possible workaround [#820](https://github.com/serbanghita/Mobile-Detect/issues/820)
|
||||
* Also see [#886](https://github.com/serbanghita/Mobile-Detect/issues/886#issuecomment-1047187763)
|
||||
* Some touchscreen devices (eg. Microsoft Surface) are tough to detect as mobile since they can be used in a laptop mode. See: [#32](https://github.com/serbanghita/Mobile-Detect/issues/32), [#461](https://github.com/serbanghita/Mobile-Detect/issues/461), [#667](https://github.com/serbanghita/Mobile-Detect/issues/667)
|
||||
* Some mobile devices (eg. IPadOS, Google Pixel Slate). See: [#795](https://github.com/serbanghita/Mobile-Detect/issues/795), [#788](https://github.com/serbanghita/Mobile-Detect/issues/788)
|
||||
* 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.
|
||||
* The script cannot detect the viewport, pixel density or resolution of the screen since it's running server-side.
|
||||
Reference in New Issue
Block a user