Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

62 lines (47 loc) · 2.63 KB
Raw

Contributing Guidelines

We love getting feedback from our users. Bugs and code contributions are great forms of feedback and we thank you for any bugs you report or code you contribute.

Reporting Issues

Before reporting a new bug, please check first to see if a similar bug exists.

Bug reports should be as complete as possible. Please try and include the following:

  • Complete steps to reproduce the issue
  • Any information about platform and environment that could be specific to the bug
  • Specific version of the product you are using
  • Specific version of the server being used
  • Code written in C/C++/VB or another language to help reproduce the issue if possible

Please do NOT raise a GitHub Issue to report a security vulnerability. See SECURITY.md for additional information.

Contributing Code

Contributing to this project is easy. You just need to follow these steps.

  • Make sure you have a user account at bugs.mysql.com. You'll need to reference this user account when you submit your OCA (Oracle Contributor Agreement).
  • Sign the Oracle Contributor Agreement. You can find instructions for doing that at OCA Page
  • Develop your pull request
  • Make sure you are aware of the requirements for the project (i.e. don't require C++20 if we are supporting C++17 and higher)
  • Validate your pull request by including tests that sufficiently cover the functionality
  • Submit your pull request
  • It is also possible to upload your changes using the 'contribution' tab to a bug record in https://bugs.mysql.com.

Only pull requests from committers that can be verified as having signed the OCA can be accepted.

Running Tests

Any contributed code should pass our unit tests. To run the unit tests you need to perform the following steps:

  • Build the Connector/ODBC
  • Register the new driver with the driver manager and create a DSN
  • Run MySQL Server
  • Set the following environment variables (optional):
    • TEST_DSN = (default = test)
    • TEST_DRIVER = (default = MySQL ODBC X.Y Driver, where X.Y is the major/minor version of the driver)
    • TEST_UID = (default = root)
    • TEST_PASSWORD = (default is an empty string)
    • TEST_SOCKET = (default is an empty string)
    • TEST_PORT = (default = 3306)
  • In the OS command line enter the test subdirectory of Connector/ODBC build directory and run ctest utility

At the end of ctest run the result should indicate 100% tests passed.