PS-9255 Adding CONTRIBUTING.md file #5445
Conversation
lukin-oleksiy
force-pushed
the
PS-9255-update-contributing_md
branch
from
db1d2ed
to
3605816
Compare
lukin-oleksiy
force-pushed
the
PS-9255-update-contributing_md
branch
2 times, most recently
from
bfadb2c
to
a67d186
Compare
| After finishing the tasks outlined above, you must prepare your branch for a pull request. | ||
| Please do not forget to run ``` git clang-format ``` on your code before pushing to the GitHub repository. | ||
|
|
||
| Then, squash all commits to one or a couple of logically consistent commits. |
There was a problem hiding this comment.
It's confusing. I understand squashing to one, but how do you squash to a couple of commits? What makes a commit logically consistent?
CONTRIBUTING.md
Outdated
|
|
||
| ### Peer review | ||
|
|
||
| Peer review of the code always goes before PR merge. So, you have to add some core development team members in the "Reviewers" field of PR. Best guess is to assign the PR to Yura Sorokin, our team lead. |
There was a problem hiding this comment.
Just say add Yura as a reviewer.
lukin-oleksiy
force-pushed
the
PS-9255-update-contributing_md
branch
from
a67d186
to
f878bd0
Compare
| 6. Testing changes | ||
| 7. Preparing the pull request | ||
| 8. Peer review and required fixes | ||
| 9. Merging pull request |
There was a problem hiding this comment.
Will the contributor merge the pull request?
|
|
||
| 1. 8.0.X - stable line. | ||
| 2. 8.4.X - next stable line, or LTS line. | ||
| 3. 9.0.X - innovation line, a test bed for everything new at the moment. |
There was a problem hiding this comment.
We don't support Innovation releases.
|
|
||
| ## Your Code and MySQL Versions | ||
|
|
||
| Percona officially supports 3 version lines of MySQL: |
There was a problem hiding this comment.
It should be "two versions of MySQL"
Spell out any single-digit number unless it's used as a number in an example or calculation.
| 2. 8.4.X - next stable line, or LTS line. | ||
| 3. 9.0.X - innovation line, a test bed for everything new at the moment. | ||
|
|
||
| Next LTS version may be 9.7, so until then 9.X are "innovation" versions. |
There was a problem hiding this comment.
No need to explain this.
|
|
||
| Steps of the workflow for submitting pull request are: | ||
|
|
||
| 1. Creating Jira issue |
There was a problem hiding this comment.
Add links to the headers
Creating Jira issue
| Therefore, your best bet is to work with the version line you're currently using and familiar with. Nevertheless, | ||
| Percona developers team will take care of your code, and port or backport it to other version lines if it is applicable. | ||
|
|
||
| ## Creating a Jira Issue |
There was a problem hiding this comment.
This header should match the unordered list item - "Create Jira issue"
| Steps of the workflow for submitting pull request are: | ||
|
|
||
| 1. Creating Jira issue | ||
| 2. Forking of Percona repository |
There was a problem hiding this comment.
Should match the headers - you should add
Working with source code as Number 2.
|
|
||
| ### Steps of the workflow | ||
|
|
||
| Steps of the workflow for submitting pull request are: |
There was a problem hiding this comment.
The following list tells the reader the order in which to submit a pull request. However, you also have items that happen after the pull request is submitted, so this header sentence is inaccurate.
Change it to pull request actions or something like submitting and following up on a pull request.
| This document describes the workflow for submitting pull requests. | ||
| By contributing, you agree to the [Percona Community code of conduct](https://percona.community/contribute/coc/). | ||
|
|
||
| ### Steps of the workflow |
There was a problem hiding this comment.
Change to ### Pull request actions
or something like that.
| It may be advisable to initially submit bug fixes to the upstream project that will eventually become part of the next | ||
| release of Percona. Alternatively, Percona provides expedited response times, transparent development processes, and | ||
| streamlined contribution acceptance within a public repository. | ||
| You can contribute in one of the following ways: |
There was a problem hiding this comment.
start a new paragraph
|
|
||
| It may be advisable to initially submit bug fixes to the upstream project that will eventually become part of the next | ||
| release of Percona. Alternatively, Percona provides expedited response times, transparent development processes, and | ||
| streamlined contribution acceptance within a public repository. |
There was a problem hiding this comment.
Working with the MySQL 8.0 source code can be time-consuming, especially for developers new to the project.
MySQL is a complex piece of software with a vast codebase. Understanding the intricacies of its architecture, data structures, and algorithms can require significant time and effort. The codebase is constantly evolving, so staying up-to-date with changes can be challenging.
Here are some factors that contribute to the complexity of working with MySQL source code:
Large codebase: MySQL has a massive codebase, making it difficult to navigate and understand.
Complex architecture: MySQL architecture is intricate and involves multiple components and layers.
Performance optimizations: MySQL is heavily optimized for performance, which can make the codebase even more complex.
Ongoing development: The MySQL project constantly evolves, with new features and bug fixes regularly added.
However, for experienced C++ developers who are familiar with database systems and are willing to invest the time and effort, working with the MySQL source code can be a rewarding experience. It can provide a deep understanding of how MySQL works and allow for customization and optimization.
PS-9255 Adding CONTRIBUTING.md file
https://perconadev.atlassian.net/browse/PS-9255