-
Notifications
You must be signed in to change notification settings - Fork 5.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve CONTRIBUTING.md with a table of ways to contribute #22724
base: master
Are you sure you want to change the base?
Conversation
CONTRIBUTING.md
Outdated
@@ -1,8 +1,20 @@ | |||
# Contributing to Presto | |||
|
|||
Thanks for your interest in Presto. Our goal is to build a fast, scalable and reliable distributed SQL query engine for running low latency interactive and batch analytic queries against data sources of all sizes ranging from gigabytes to petabytes. | |||
Thanks for your interest in Presto. Our goal is to build a fast, scalable and reliable distributed SQL query engine for running low latency interactive and batch analytic queries against data sources of all sizes ranging from gigabytes to petabytes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oxford comma after scalable
CONTRIBUTING.md
Outdated
| Report Bug | To report a bug, visit Presto's [open issues](https://github.com/prestodb/presto/issues). | | ||
| Contributions | Please read the [contributions](#contributions) section to learn about how you can contribute to Presto, including the submission process, minimum expectations, and guidelines for designing your code. | | ||
| Pull Requests | Ready to commit your code to the main branch? Be sure to review the [Pull Request guidelines](#pullrequests) . | | ||
| Contributor License Agreement ("CLA") | For first-time contributors, a CLA must be signed. Read more about it [here](#cla). | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
active voice: First-time contributors must sign a CLA.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for following up on the idea from #21736! A couple of nits and some suggestions for improvement.
b3947ee
to
c35143b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! (docs)
Review of updated file, no new comments to make. Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! Just one suggestion.
I'd also like to add a new section on "Supporting users". This would be helping on Slack and responding to issues (similar to the Paimon example in the reference issue), and also helping to review code (and linking to guidelines in CONTRIBUTING.md on what to look for).
CONTRIBUTING.md
Outdated
| Contributions | Please read the [contributions](#contributions) section to learn about how you can contribute to Presto, including the submission process, minimum expectations, and guidelines for designing your code. | | ||
| Pull Requests | Ready to commit your code to the main branch? Be sure to review the [Pull Request guidelines](#pullrequests) . | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Contributions | Please read the [contributions](#contributions) section to learn about how you can contribute to Presto, including the submission process, minimum expectations, and guidelines for designing your code. | | |
| Pull Requests | Ready to commit your code to the main branch? Be sure to review the [Pull Request guidelines](#pullrequests) . | | |
| Contributions | Please read the [contributions](#contributions) section to learn about how you can contribute to Presto, including the submission process, minimum expectations, and guidelines for designing your code. Ready to open a pull request? Be sure to review the [Pull Request guidelines](#pullrequests) . | |
c35143b
to
bf0ea53
Compare
Failed test |
Is there anything else that stands out? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One formatting error I noticed, otherwise looks good. Thanks!
| Getting Started | Read Presto's [open issues](https://github.com/prestodb/presto/issues). Tag issues that would make a good first pull request for new contributors with a [good first issue](https://github.com/prestodb/presto/labels/good%20first%20issue) tag. An easy way to start helping the project is to [open an issue](https://github.com/prestodb/presto/issues/new/choose). Issues can include bugs, new features, or outdated documentation. | | ||
| Building Presto | Please review the minimum system specs [requirements](#requirements) before [building](#buildingpresto) Presto. | | ||
| Report Bug | To report a bug, visit Presto's [open issues](https://github.com/prestodb/presto/issues). | | ||
| Contributions | Please read the [contributions](#contributions) section to learn about how you can contribute to Presto, including the submission process, minimum expectations, and guidelines for designing your code. Ready to open a pull request? Be sure to review the [Pull Request guidelines](#pullrequests). || Contributor License Agreement ("CLA") | First-time contributors must sign a CLA. For more information see [Contributor License Agreement ("CLA")](#cla). | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Contributions | Please read the [contributions](#contributions) section to learn about how you can contribute to Presto, including the submission process, minimum expectations, and guidelines for designing your code. Ready to open a pull request? Be sure to review the [Pull Request guidelines](#pullrequests). || Contributor License Agreement ("CLA") | First-time contributors must sign a CLA. For more information see [Contributor License Agreement ("CLA")](#cla). | | |
| Contributions | Please read the [contributions](#contributions) section to learn about how you can contribute to Presto, including the submission process, minimum expectations, and guidelines for designing your code. Ready to open a pull request? Be sure to review the [Pull Request guidelines](#pullrequests). | | |
| Contributor License Agreement ("CLA") | First-time contributors must sign a CLA. For more information see [Contributor License Agreement ("CLA")](#cla). | |
Missing line return between the "||" in "|| Contributor License Agreement" made the row vanish.
I have found that a great way to check this kind of formatting error with Markdown files in Github is to select "..." in the upper right of the file, then selecting "View file".
|
||
| Area | Information | | ||
|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| Getting Started | Read Presto's [open issues](https://github.com/prestodb/presto/issues). Tag issues that would make a good first pull request for new contributors with a [good first issue](https://github.com/prestodb/presto/labels/good%20first%20issue) tag. An easy way to start helping the project is to [open an issue](https://github.com/prestodb/presto/issues/new/choose). Issues can include bugs, new features, or outdated documentation. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we make getting started be:
- Build presto (remove section below, inline here). Look for good first issue tickets. Reference project boards for open work: https://github.com/prestodb/presto/projects?query=is%3Aopen
Description
Added a table to CONTRIBUTING.md to help users quickly navigate CONTRIBUTING.md.
Motivation and Context
Suggestion made here #21736
Impact
No feature impact
Test Plan
N/A
Contributor checklist
Release Notes
Please follow release notes guidelines and fill in the release notes below.