Skip to content

Latest commit

 

History

History
48 lines (40 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

48 lines (40 loc) · 2.07 KB

Reporting issues

  1. Specify the User-agent by visiting http://demo.mobiledetect.net.
  2. Specify the expected behaviour.

Developing

  1. Fork Mobile Detect repository. See "How to fork" 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
  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!
    2. If you add new regexes make sure you commit the User-Agents in tests/providers/vendors
  8. Run tests vendor/bin/phpunit -v -c tests/phpunit.xml --coverage-text --strict-coverage --stop-on-risky
  9. git status or git diff - inspect your changes 1 git stage .
  10. git commit -m "[your commit message here]
  11. git push origin devel
  12. Go to your repo on GitHub and "Submit the PR"

New module, plugin, plugin or port

Submit new module, plugin, port 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.
  2. The files are found on the gh-pages branch.
  3. git checkout gh-pages
  4. npm install -g browser-sync
  5. browser-sync start --s . --f . --port 3000 --reload-debounce 1500 --no-ui
  6. Go to http://localhost:3000 and make changes.
  7. Commit, push and submit the PR against serbanghita:gh-pages.