Improve CONTRIBUTING.md with a table of ways to contribute #22724
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elharo
reviewed
May 13, 2024
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.
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.
active voice: First-time contributors must sign a CLA.
steveburnett
requested changes
May 13, 2024
There was a problem hiding this comment.
Thanks for following up on the idea from #21736! A couple of nits and some suggestions for improvement.
efrancisworks
force-pushed
the
issue-21736
branch
from
b3947ee
to
c35143b
Compare
efrancisworks
commented
May 13, 2024
steveburnett
previously approved these changes
May 14, 2024
tdcmeehan
reviewed
May 14, 2024
There was a problem hiding this comment.
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
Comment on lines
12
to
13
| | 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.
Suggested change
| | 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) . | |
efrancisworks
force-pushed
the
issue-21736
branch
from
c35143b
to
bf0ea53
Compare
|
Failed test |
|
Is there anything else that stands out? |
steveburnett
requested changes
May 21, 2024
| | 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.
Suggested change
| | 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".
tdcmeehan
reviewed
May 22, 2024
|
|
||
| | 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.
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
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.