Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 2.87 KB
Raw

Contributing

Requirements

  • Go 1.19 or higher

Getting Started

  1. Fork the repository and clone it locally
  2. Run go mod download to download dependencies
  3. Run go test ./... to run all tests

Testing

The tests are located in the matchers, devices, platforms and browser packages. The tests are using the assets/test directory to load the user agents data.

Package follows BDD style test cases. The tests are using the GoConvey library to write BDD style tests.

Adding a new browser support

Every browser implements the BrowserMatcher interface.

  1. Add the file to the matchers package.
  2. Add the new browser the list of matchers in browser.go. Make sure the order of the matchers is correct. The order of the matchers is important because the first matcher that returns true will be used.
  3. Add specific tests for the new browser in the matchers package. Make sure to test all the possible user agents for the browser. You can use this website to find user agents for the browser.
  4. Add the user agents data to matchers.yml file.
  5. Add all necerssary functions to Browser struct in browser.go file.

Adding a new device support

Every device implements the DeviceMatcher interface.

  1. Add the file to the devices package.
  2. Add the new device to list of DeviceMatcher in device.go. Make sure the order of the matchers is correct. The order of the matchers is important because the first matcher that returns true will be used.
  3. Add specific tests for the new device in the devices package. Make sure to test all the possible user agents for the device. You can use this website to find user agents for the device.
  4. Add the user agents data to devices.yml file.
  5. Add all necerssary functions to Device struct in device.go file.

Adding a new platform support

Every platform implements the PlatformMatcher interface.

  1. Add the file to the platforms package.
  2. Add the new platform to list of PlatformMatcher in platform.go. Make sure the order of the matchers is correct. The order of the matchers is important because the first matcher that returns true will be used.
  3. Add specific tests for the new platform in the platforms package. Make sure to test all the possible user agents for the platform. You can use this website to find user agents for the platform.
  4. Add the user agents data to platforms.yml file.
  5. Add all necerssary functions to Platform struct in platform.go file.

Adding a new known bot support

  1. Add the new bot to known_bots.yml.