Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 4.1 KB

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 4.1 KB
Raw

Contributing Guidelines

We greatly appreciate feedback from our users, including bug reports and code contributions. Your input helps us improve, and we thank you for any issues you report or code you contribute.

Reporting Issues

Before submitting a new bug report, please check here to see if the issue has already been reported.

When reporting a bug, ensure your report is as detailed as possible. Please include the following:

  • Clear, reproducible steps to demonstrate the issue.
  • Relevant platform and environment information.
  • The specific version of the product in use.
  • The version of the MySQL Server in use.
  • Sample code that can help reproduce the issue, if applicable.

Contributing Code

We welcome your code contributions. Before submitting code via a GitHub pull request or by filing a bug on bugs.mysql.com, you will need to sign the Oracle Contributor Agreement (OCA). Instructions for signing the OCA are available on the OCA Page.

Only pull requests from contributors who have signed the OCA can be accepted.

Submitting a Contribution

  1. Ensure you have a user account at bugs.mysql.com. You'll need to reference this account when submitting your OCA.
  2. Sign the Oracle Contributor Agreement. Instructions are provided on the OCA Page.
  3. Validate your contribution by including tests that adequately cover the functionality you're adding.
  4. Ensure the entire test suite passes with your changes applied.
  5. Submit your pull request through GitHub or upload it to a bug record on bugs.mysql.com using the Contributions tab.

Developing Your Pull Request

  1. Create your pull request, following the project's requirements.
  2. Include sufficient tests to validate the new functionality.
  3. Confirm that the entire test suite passes with your changes applied.
  4. Submit the pull request via GitHub or directly via bugs.mysql.com.

We deeply value contributions to MySQL and thank you for supporting open-source development.

Setting Up a Development Environment

You can use your preferred .NET IDE to view, edit, and compile the MySQL Connector/NET source code. For project configuration, please refer to the instructions in Installing from Source.

Running Tests

Any code you contribute must pass our test suite. Each project has its own suite (e.g., MySql.Data.Tests). Be sure to run the entire test suite to ensure that no other functionality is affected by your changes. You can run the tests using your preferred IDE or via the CLI with the "dotnet" tool.

Getting Help

If you need assistance or would like to reach out to the community, please use the following resources:

We look forward to hearing from you and encourage you to get involved. Happy coding!

X (formerly Twitter) Follow