MySQL :: Contributing to MySQL
Skip to Main Content Contributing to MySQL Welcome to the MySQL Contributor Community This guide is written to help you get started with your first contributions to MySQL Server source code. Whether you are just passing by to submit a bug fix or you will be working on a bigger project, we hope that you will find both this guide and the people who wrote it helpful and friendly. As the project is going through a lot of changes in 2026, this guide may sometimes be out of date.
We do our best to update it, but if you find something that is missing or does not feel right, do not hesitate to ask in MySQL Community GitHub Discussions . Welcome to the MySQL open source project. You can also read a longer welcome note from us to you . Get Connected Your first step in getting involved with software development for the MySQL project should be to join the MySQL Community GitHub Discussions relevant to your area of interest.
The MySQL Community GitHub Discussions are the central point for discussions related to MySQL Server software development, including technical topics, proposals, roadmap feedback, and contribution-related questions. The MySQL Community Slack may also be used for general community discussions and engagement. Please note that Slack, Zoom, LinkedIn, and other helpful media are considered outside the project infrastructure.
Whenever you have an interesting discussion elsewhere, and especially when you make project decisions, summarize it in a GitHub discussion thread, wiki page, or relevant issue. Depending on your intended level of involvement, you may also want to sign up for a centralized Oracle user account. It gives you access to the discussion forums , the MySQL bug database , and other MySQL services. What You Need to Submit a Contribution If you intend to submit code contributions to MySQL, you will need: A GitHub user account, if you do not already have one.
Optionally, an Oracle user account. A signed Oracle Contribution Agreement. Sign Up for a GitHub Account If you do not yet have a GitHub account, go to github.com and create one from the home page. Sign Up for a MySQL Bug System Account Whether you intend to fix bugs or write entirely new features, you will need a bugs.mysql.com account. The MySQL bug system currently connects the other systems together. The MySQL bug system uses the same login as Oracle systems.
If you already have an Oracle user account, you can use it to log in to MySQL systems. If you need to set up a new user, register . Sign the Oracle Contribution Agreement An Oracle Contribution Agreement (OCA) is required in order to accept code contributions. Without a submitted and approved OCA, Oracle cannot integrate your contribution into the MySQL code base or engage in discussions on proposed patches. If your MySQL contributions are part of your work, you must arrange for your employer to sign the OCA and list you as a person allowed to contribute to MySQL.
Corporations should administer contributors through the OCA Administrative Tool to identify all contributors covered under their OCA. Submit the OCA Step by Step Go to the Oracle Contributor Agreement application . Log in using your Oracle account. Decide whether you would like to submit an individual or company OCA. Fill in all requested details. Sign using DocuSign and submit. If you have previously signed or submitted the OCA, formerly the Sun Contributor Agreement, for a different project, you can contribute to the MySQL project under the same SCA or OCA.
If you have previously signed the MySQL Contributor License Agreement, you must sign and return the OCA instead. All contributions to the MySQL project require the contributor to sign and return the OCA. For questions, see the OCA FAQ . What Contribution Can You Make We recognize five types of contributions that MySQL users typically make. This project and guide are designed with these activities in mind. It helps to identify the type of contribution that interests you.
If your contribution is not in this list, go to MySQL Community GitHub Discussions and tell us what you want to do. Found a Bug If you have found a bug, you can report it in the bug-tracking system so others can work on fixing it. If you want to work on the bug yourself, indicate that when you file it. Fix a Bug A great way to start contributing code to MySQL is to fix a bug. We have hundreds of open bugs at any given time, and many are easy to fix.
Browse the backlog in the MySQL BugsDB to find an existing bug to work on. Small, self-contained bugs can be a good starting point for new contributors. Try searching for severity S3 or S7. Submit your fix as a pull request against the correct version in the mysql-server repository . Bug fixes generally do not need the design document mentioned in the next section. A bug is something that does not work according to its design specification, so the design already exists and the fix aligns the implementation with the existing design or documentation.
Propose or Work on a New Feature Use MySQL Community GitHub Discussions to share ideas with the community. To submit a new feature request or feature proposal, use MySQL Server GitHub Issues . Select Feature request if you do not plan to write the code for the feature. Select Feature contribution if you have written or intend to write the code. After submitting an issue that describes your feature at a high level, follow Proposal Design and Implementation Using a Single Pull Request for details about how we design, discuss, and write new features.
See the MySQL source code documentation . You do not need to read all of it immediately, but you should become familiar with the MySQL Coding Guidelines and the chapter on testing . The CONTRIBUTING.md file in the MySQL Server repository provides the commands to run for building, linting, formatting, and testing your patch. Improve Documentation If you want to help improve the documentation, stay tuned. This is a focus area for Q4 2026.
Test and Provide Feedback If you want to test new features and provide feedback: Go to labs.mysql.com and download the latest Early Access release. For documentation, use the latest Community Edition Reference Manual and MySQL Server Version Reference . Some Early Access features might not yet be in the manual; in that case, look for a blog post or another document, such as the feature's WorkLog . Discuss your findings and share feedback in MySQL Community GitHub Discussions .
Other community members are likely testing the same feature. If necessary, file a bug report at bugs.mysql.com . Enter the appropriate version or build identifier, such as 9.7.0-ER, and use the EARLY_RELEASE tag. Sanitize logs, metrics, and benchmarks before sharing them. Your first experiences with an Early Access feature can make a useful blog post. Create a blog if you do not have one, and make sure it is added to Planet MySQL.
Submit a Patch Through GitHub The MySQL repositories on GitHub are available at https://github.com/mysql . When you submit a pull request, you will be asked to: Sign an OCA, if you do not already have one. Confirm that the pull request is submitted under the terms of the OCA. Once you confirm that the contribution is under the terms of the OCA, your pull request will be reviewed. If the pull request fixes a bug, you may already be close to the finish line.
A reviewer will mark the patch as approved and submit it to an internal process, where it is rebased, tested, and ultimately merged into the trunk branch. If the pull request introduces a new feature, the work is only beginning. Start by writing the high-level and detailed design in a Markdown file that is part of the pull request. Once the design is clear, write the implementation in the same pull request. When both the design and code are ready and approved, the pull request is closed and assigned to the internal merge queue.
Testing The development of tests and test frameworks, and the execution of test suites, are importan
The rest of this page is on the live site.