Skip to content

Commit cf2917e

Browse files
committed
Update for CONTRIBUTING and README files, and new file SECURITY.md.
Change-Id: Ia9a2128e57f57c3999c1ff5f9928115adf8693a4
1 parent cc462a6 commit cf2917e

File tree

4 files changed

+104
-52
lines changed

4 files changed

+104
-52
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,62 @@
11
# Contributing Guidelines
22

3-
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.
3+
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.
44

55
## Reporting Issues
66

7-
Before reporting a new bug, please [check first](https://bugs.mysql.com/search.php) to see if a similar bug already exists.
7+
Before submitting a new bug report, please [check here](https://bugs.mysql.com/search.php) to see if the issue has already been reported.
88

9-
Bug reports should be as complete as possible. Please try and include the following:
9+
When reporting a bug, ensure your report is as detailed as possible. Please include the following:
1010

11-
* Complete steps to reproduce the issue.
12-
* Any information about platform and environment that could be specific to the bug.
13-
* Specific version of the product you are using.
14-
* Specific version of the server being used.
15-
* Sample code to help reproduce the issue, if possible.
11+
* Clear, reproducible steps to demonstrate the issue.
12+
* Relevant platform and environment information.
13+
* The specific version of the product in use.
14+
* The version of the MySQL Server in use.
15+
* Sample code that can help reproduce the issue, if applicable.
1616

1717
## Contributing Code
1818

19-
Contributing to MySQL projects is easy. You just need to follow these steps.
19+
We welcome your code contributions. Before submitting code via a GitHub pull request or by filing a bug on [bugs.mysql.com](https://bugs.mysql.com), you will need to sign the Oracle Contributor Agreement (OCA). Instructions for signing the OCA are available on the [OCA Page](https://oca.opensource.oracle.com).
2020

21-
* Make sure you have a user account at [bugs.mysql.com](https://bugs.mysql.com). You will need to reference this user account when you submit your Oracle Contributor Agreement (OCA).
22-
* Sign the Oracle Contributor Agreement. You can find instructions for doing that at the [OCA Page](https://oca.opensource.oracle.com/).
23-
* Develop your pull request. Make sure you are aware of the requirements for the project (e.g. do not require Java 7 if we are supporting Java 8 and higher).
24-
* Validate your pull request by including tests that sufficiently cover the functionality you are adding.
25-
* Verify that the entire test suite passes with your code applied.
26-
* Submit your pull request. While you can submit the pull request via [GitHub](https://github.com/mysql/mysql-connector-j/pulls), you can also submit it directly via [bugs.mysql.com](https://bugs.mysql.com).
21+
**Only pull requests from contributors who have signed the OCA can be accepted.**
2722

28-
Thanks again for your wish to contribute to MySQL. We truly believe in the principles of open source development and appreciate any contributions to our projects.
23+
### Submitting a Contribution
24+
25+
1. Ensure you have a user account at [bugs.mysql.com](https://bugs.mysql.com). You'll need to reference this account when submitting your OCA.
26+
2. Sign the Oracle Contributor Agreement. Instructions are provided on the [OCA Page](https://oca.opensource.oracle.com).
27+
3. Validate your contribution by including tests that adequately cover the functionality you're adding.
28+
4. Ensure the entire test suite passes with your changes applied.
29+
5. Submit your pull request through [GitHub](https://github.com/mysql/mysql-connector-j/pulls/) or upload it to a bug record on [bugs.mysql.com](https://bugs.mysql.com) using the _Contributions_ tab.
30+
31+
### Developing Your Pull Request
32+
33+
1. Create your pull request, following the [project's requirements](https://dev.mysql.com/doc/connector-j/en/connector-j-installing.html).
34+
2. Include sufficient tests to validate the new functionality.
35+
3. Confirm that the entire test suite passes with your changes applied.
36+
4. Submit the pull request via [GitHub](https://github.com/mysql/mysql-connector-j/pulls/) or directly via [bugs.mysql.com](https://bugs.mysql.com).
37+
38+
We deeply value contributions to MySQL and thank you for supporting open-source development.
2939

3040
## Setting Up a Development Environment
3141

32-
You can use your preferred Java IDE to view, edit, and compile the MySQL Connector/J source code. The configuration setup can be adapted from [Installing from Source](https://dev.mysql.com/doc/connector-j/en/connector-j-installing-source.html) with little effort.
42+
You can use your preferred Java IDE to view, edit, and compile the MySQL Connector/J source code. For project configuration, please refer to the instructions in [Installing from Source](https://dev.mysql.com/doc/connector-j/en/connector-j-installing-source.html).
3343

34-
Running the entire test suite or your own test case is also possible by setting a few Ant properties in your IDE preferences setup. Refer to [Testing Connector/J](https://dev.mysql.com/doc/connector-j/en/connector-j-testing.html) for additional details.
44+
To run the full test suite or individual test cases, configure the necessary Ant properties within your IDE preferences. For further details, see [Testing Connector/J](https://dev.mysql.com/doc/connector-j/en/connector-j-testing.html).
3545

3646
## Getting Help
3747

38-
If you need help or just want to get in touch with us, please use the following resources:
48+
If you need assistance or would like to reach out to the community, please use the following resources:
3949

40-
* [MySQL Connector/J, JDBC and Java forum](https://forums.mysql.com/list.php?39).
41-
* [`#connectors` channel in MySQL Community Slack](https://mysqlcommunity.slack.com/messages/connectors). ([Sign-up](https://lefred.be/mysql-community-on-slack/) required if you do not have an Oracle account.)
42-
* [@MySQL on Twitter](https://twitter.com/MySQL).
50+
* [MySQL Connector/J Developer Guide](https://dev.mysql.com/doc/connector-j/en/).
51+
* [MySQL Connector/J X DevAPI Reference](https://dev.mysql.com/doc/dev/connector-j/).
52+
* [MySQL Connector/J, JDBC and Java Forum](https://forums.mysql.com/list.php?39).
53+
* [`#connectors` channel on MySQL Community Slack](https://mysqlcommunity.slack.com/messages/connectors/) ([Sign-up](https://lefred.be/mysql-community-on-slack/) required if you do not have an Oracle account.)
54+
* [@MySQL on X](https://x.com/MySQL/).
4355
* [MySQL Blog](https://blogs.oracle.com/mysql/).
4456
* [MySQL Connectors Blog archive](https://dev.mysql.com/blog-archive/?cat=Connectors%20%2F%20Languages).
4557
* [MySQL Newsletter](https://www.mysql.com/news-and-events/newsletter/).
46-
* [MySQL Bugs Database](https://bugs.mysql.com/).
58+
* [MySQL Bugs Tracking System](https://bugs.mysql.com).
4759

48-
We hope to hear from you soon. Enjoy your coding!
60+
We look forward to hearing from you and encourage you to get involved. Happy coding!
4961

50-
[![Twitter Follow](https://img.shields.io/twitter/follow/MySQL.svg?label=Follow%20%40MySQL&style=social)](https://twitter.com/intent/follow?screen_name=MySQL)
62+
[![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/MySQL?style=social)](https://x.com/intent/follow?screen_name=MySQL)

README

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,39 @@
11
Copyright (c) 2000, 2024, Oracle and/or its affiliates.
22

3-
This is a release of MySQL Connector/J, a JDBC Type 4 driver for MySQL that
4-
also supports the new X DevAPI.
3+
This is a release of MySQL Connector/J, a JDBC Type 4 driver for MySQL that also
4+
supports the new X DevAPI.
55

6-
License information can be found in the LICENSE file.
7-
8-
This distribution may include materials developed by third parties.
9-
For license and attribution notices for these materials, please refer to the
10-
LICENSE file.
6+
License information can be found in the LICENSE file. This distribution may
7+
include materials developed by third parties. For license and attribution
8+
notices for these materials, please refer to the LICENSE file.
119

1210
For more information on MySQL Connector/J, visit
13-
https://dev.mysql.com/doc/connector-j/en/
11+
https://dev.mysql.com/doc/connector-j/en/.
1412

15-
For additional downloads and the source of MySQL Connector/J, visit
16-
https://dev.mysql.com/downloads/
13+
For additional downloads and the source of MySQL Connector/J,
14+
visit https://dev.mysql.com/downloads/.
1715

1816
MySQL Connector/J is brought to you by the MySQL team at Oracle.
1917

2018
Notice:
2119
- In order to use the logging capabilities provided by the default
22-
implementation com.mysql.cj.log.Slf4JLogger, it is required to add one or
23-
more jars for Simple Logging Facade for Java (SLF4J) to your CLASSPATH.
20+
implementation com.mysql.cj.log.Slf4JLogger, it is required to add one or more
21+
jars for Simple Logging Facade for Java (SLF4J) to your CLASSPATH.
2422
- To use the X DevAPI features in Connector/J, you also need the external
25-
library protobuf-java, which you can download manually from the official
26-
Maven repository and add it to the CLASSPATH, or use Maven's automatic
27-
dependency resolution features by adding a dependency to "GroupId: com.mysql"
28-
and "ArtifactId: mysql-connector-j" to your project's pom.xml file.
23+
library protobuf-java, which you can download manually from the official Maven
24+
repository and add it to the CLASSPATH, or use Maven's automatic dependency
25+
resolution features by adding a dependency to "GroupId: com.mysql" and
26+
"ArtifactId: mysql-connector-j" to your project's pom.xml file.
2927
- To use OCI AIM authentication, you will need to add the external library
3028
oci-java-sdk-common, which you can download manually from the official Maven
3129
repository and add it to the CLASSPATH, or use Maven's automatic dependency
3230
resolution features by adding a dependency to "GroupId: com.oracle.oci.sdk"
3331
and "ArtifactId: oci-java-sdk-common" to your project's pom.xml file.
32+
- In order to enable OpenTelemtry native instrumentation, it is required to use
33+
the OpenTelemetry libraries opentelemetry-api and opentelemetry-context, and
34+
an OpenTelemetry implementation, typically the library opentelemetry-sdk or
35+
the Java agent opentelemetry-javaagent, which you can download manually from
36+
the official Maven repository and add it to the CLASSPATH, or use Maven's
37+
automatic dependency resolution features, by adding a dependency to
38+
"GroupId: io.opentelemetry" and the corresponding artifacts to your project's
39+
pom.xml file.

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# MySQL Connector/J
22

3-
[![GitHub top language](https://img.shields.io/github/languages/top/mysql/mysql-connector-j?label=Java&color=5382a1)](https://github.com/mysql/mysql-connector-j/tree/release/9.x/src) [![License: GPLv2 with FOSS exception](https://img.shields.io/badge/License-GPLv2_with_FOSS_exception-c30014.svg)](LICENSE) [![Maven Central](https://img.shields.io/maven-central/v/com.mysql/mysql-connector-j?label=Maven%20Central)](https://central.sonatype.com/search?q=g%3Acom.mysql+a%3Amysql-connector-j)
3+
[![GitHub top language](https://img.shields.io/github/languages/top/mysql/mysql-connector-j?label=Java&color=5382a1)](https://github.com/mysql/mysql-connector-j/tree/release/9.x/src/) [![License: GPLv2 with FOSS exception](https://img.shields.io/badge/License-GPLv2_with_FOSS_exception-c30014)](LICENSE) [![Maven Central Version](https://img.shields.io/maven-central/v/com.mysql/mysql-connector-j?label=Maven%20Central)](https://central.sonatype.com/search?q=g%3Acom.mysql+a%3Amysql-connector-j)
44

5-
MySQL provides connectivity for client applications developed in the Java programming language with MySQL Connector/J, a driver that implements the [Java Database Connectivity (JDBC) API](https://www.oracle.com/technetwork/java/javase/jdbc/) and also [MySQL X DevAPI](https://dev.mysql.com/doc/x-devapi-userguide/en/).
5+
MySQL provides connectivity for client applications developed in the Java programming language with MySQL Connector/J, a driver that implements the [Java Database Connectivity (JDBC) API](https://www.oracle.com/java/technologies/javase/javase-tech-database.html) and also [MySQL X DevAPI](https://dev.mysql.com/doc/x-devapi-userguide/en/).
66

77
MySQL Connector/J 9.1 is a JDBC Type 4 driver that is compatible with the [JDBC 4.2](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) specification. The Type 4 designation means that the driver is a pure Java implementation of the MySQL protocol and does not rely on the MySQL client libraries.
88

@@ -14,6 +14,10 @@ For more information, please visit the official [MySQL Connector/J documentation
1414

1515
Please refer to the [README](README) and [LICENSE](LICENSE) files, available in this repository, and the [Legal Notices in the MySQL Connector/J documentation](https://dev.mysql.com/doc/connector-j/en/preface.html) for further details.
1616

17+
## Security
18+
19+
Oracle values the independent security research community and believes that responsible disclosure of security vulnerabilities helps us ensure the security and privacy of all our users. Please refer to the [security guidelines](SECURITY.md) document for additional information.
20+
1721
## Getting the Latest Release
1822

1923
MySQL Connector/J is free for usage under the terms of the specified licensing and it runs on any operating system that is able to run a Java Virtual Machine.
@@ -23,9 +27,10 @@ MySQL Connector/J is free for usage under the terms of the specified licensing a
2327
MySQL Connector/J can be installed from pre-compiled packages that can be downloaded from the [MySQL Connector/J download page](https://dev.mysql.com/downloads/connector/j/). Installing MySQL Connector/J only requires obtaining the corresponding JAR file from the downloaded bundle or installer and including it in the application's CLASSPATH.
2428

2529
According to how you use MySQL Connector/J, you may also need to install the following third-party libraries on your system for it to work:
26-
* Protocol Buffers (protobuf-java) is required for using X DevAPI
27-
* Oracle Cloud Infrastructure SDK for Java (oci-java-sdk) is required to support OCI AIM authentication
28-
* Simple Logging Facade API (slf4j-api) is required for using the logging capabilities provided by the default implementation of org.slf4j.Logger.Slf4JLogger by MySQL Connector/J
30+
* Protocol Buffers (protobuf-java) is required for using X DevAPI.
31+
* Oracle Cloud Infrastructure SDK for Java (oci-java-sdk) is required to support OCI AIM authentication.
32+
* Simple Logging Facade API (slf4j-api) is required for using the logging capabilities provided by the default implementation of org.slf4j.Logger.Slf4JLogger by MySQL Connector/J.
33+
* OpenTelemetry API and SDK are required for enabling OpenTelemetry native instrumentation.
2934

3035
### As a Maven Dependency
3136

@@ -65,20 +70,20 @@ This repository contains the MySQL Connector/J source code as per the latest rel
6570

6671
## Contributing
6772

68-
There are a few ways to contribute to the MySQL Connector/J code. Please refer to the [contributing guidelines](CONTRIBUTING.md) for additional information.
73+
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. Please refer to the [contributing guidelines](CONTRIBUTING.md) document for additional information.
6974

7075
## Additional Resources
7176

7277
* [MySQL Connector/J Developer Guide](https://dev.mysql.com/doc/connector-j/en/).
7378
* [MySQL Connector/J X DevAPI Reference](https://dev.mysql.com/doc/dev/connector-j/).
74-
* [MySQL Connector/J, JDBC and Java forum](https://forums.mysql.com/list.php?39).
75-
* [`#connectors` channel in MySQL Community Slack](https://mysqlcommunity.slack.com/messages/connectors). ([Sign-up](https://lefred.be/mysql-community-on-slack/) required if you do not have an Oracle account.)
76-
* [@MySQL on Twitter](https://twitter.com/MySQL).
79+
* [MySQL Connector/J, JDBC and Java Forum](https://forums.mysql.com/list.php?39).
80+
* [`#connectors` channel in MySQL Community Slack](https://mysqlcommunity.slack.com/messages/connectors) ([Sign-up](https://lefred.be/mysql-community-on-slack/) required if you do not have an Oracle account.)
81+
* [@MySQL on X](https://x.com/MySQL/).
7782
* [MySQL Blog](https://blogs.oracle.com/mysql/).
7883
* [MySQL Connectors Blog archive](https://dev.mysql.com/blog-archive/?cat=Connectors%20%2F%20Languages).
7984
* [MySQL Newsletter](https://www.mysql.com/news-and-events/newsletter/).
80-
* [MySQL Bugs Database](https://bugs.mysql.com/).
85+
* [MySQL Bugs Tracking System](https://bugs.mysql.com).
8186

8287
For more information about this and other MySQL products, please visit [MySQL Contact & Questions](https://www.mysql.com/about/contact/).
8388

84-
[![Twitter Follow](https://img.shields.io/twitter/follow/MySQL.svg?label=Follow%20%40MySQL&style=social)](https://twitter.com/intent/follow?screen_name=MySQL)
89+
[![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/MySQL.svg?label=Follow%20%40MySQL&style=social)](https://x.com/intent/follow?screen_name=MySQL)

SECURITY.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Reporting security vulnerabilities
2+
3+
Oracle values the independent security research community and believes that
4+
responsible disclosure of security vulnerabilities helps us ensure the security
5+
and privacy of all our users.
6+
7+
Please do NOT raise a GitHub Issue to report a security vulnerability. If you
8+
believe you have found a security vulnerability, please submit a report to
9+
secalert_us@oracle.com preferably with a proof of concept. Please review some
10+
additional information [on how to report security vulnerabilities to Oracle](https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html).
11+
We encourage people who contact Oracle Security to use email encryption using
12+
our [encryption key](https://www.oracle.com/security-alerts/encryptionkey.html).
13+
14+
We ask that you do not use other channels or contact the project maintainers
15+
directly.
16+
17+
# Security updates, alerts and bulletins
18+
19+
Security updates will be released on a regular cadence. Many of our projects
20+
will typically release security fixes in conjunction with the Oracle Critical
21+
Patch Update program. Additional information, including past advisories, is
22+
available on our [security alerts page](https://www.oracle.com/security-alerts/).
23+
24+
# Security-related information
25+
26+
We will provide security related information such as a threat model,
27+
considerations for secure use, or any known security issues in our
28+
documentation. Please note that labs and sample code are intended to demonstrate
29+
a concept and may not be sufficiently hardened for production use.

0 commit comments

Comments
 (0)