|
1 | 1 | # Contributing Guidelines |
2 | 2 |
|
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. |
4 | 4 |
|
5 | 5 | ## Reporting Issues |
6 | 6 |
|
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. |
8 | 8 |
|
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: |
10 | 10 |
|
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. |
16 | 16 |
|
17 | 17 | ## Contributing Code |
18 | 18 |
|
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). |
20 | 20 |
|
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.** |
27 | 22 |
|
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. |
29 | 39 |
|
30 | 40 | ## Setting Up a Development Environment |
31 | 41 |
|
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). |
33 | 43 |
|
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). |
35 | 45 |
|
36 | 46 | ## Getting Help |
37 | 47 |
|
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: |
39 | 49 |
|
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/). |
43 | 55 | * [MySQL Blog](https://blogs.oracle.com/mysql/). |
44 | 56 | * [MySQL Connectors Blog archive](https://dev.mysql.com/blog-archive/?cat=Connectors%20%2F%20Languages). |
45 | 57 | * [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). |
47 | 59 |
|
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! |
49 | 61 |
|
50 | | -[](https://twitter.com/intent/follow?screen_name=MySQL) |
| 62 | +[](https://x.com/intent/follow?screen_name=MySQL) |
0 commit comments