Improve CONTRIBUTING.md with a table of ways to contribute by efrancisworks · Pull Request #22724 · prestodb/presto

efrancisworks · 2024-05-13T04:29:15Z

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

Please make sure your submission complies with our development, formatting, commit message, and attribution guidelines.
PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
Documented new properties (with its default value), SQL syntax, functions, or other functionality.
If release notes are required, they follow the release notes guidelines.
Adequate tests were added if applicable.
CI passed.

Release Notes

Please follow release notes guidelines and fill in the release notes below.

== NO RELEASE NOTE ==

elharo · 2024-05-13T15:11:40Z

CONTRIBUTING.md

 # 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.


Oxford comma after scalable

elharo · 2024-05-13T15:12:21Z

CONTRIBUTING.md

+| 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).                                                                                                                                                                                                                                                                                                |


active voice: First-time contributors must sign a CLA.

steveburnett

Thanks for following up on the idea from #21736! A couple of nits and some suggestions for improvement.

CONTRIBUTING.md

steveburnett

LGTM! (docs)

Review of updated file, no new comments to make. Thanks!

tdcmeehan

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).

tdcmeehan · 2024-05-14T14:50:41Z

CONTRIBUTING.md

+| 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) .                                                                                                                                                                                                                                                                     |


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) . |

steveburnett · 2024-05-16T15:36:43Z

Failed test [test / test (:presto-tests -P presto-tests-general) (pull_request)](https://github.com/prestodb/presto/actions/runs/9106986440/job/25035077625?pr=22724). Has this test been flaky recently?

efrancisworks · 2024-05-21T20:11:39Z

Is there anything else that stands out?

steveburnett

One formatting error I noticed, otherwise looks good. Thanks!

CONTRIBUTING.md

tdcmeehan · 2024-05-22T15:01:07Z

CONTRIBUTING.md

+
+| 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.  |


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

tdcmeehan

I would inline the link to the project boards, otherwise LGTM!

tdcmeehan · 2024-05-28T23:53:06Z

CONTRIBUTING.md

+
+| Area             | Information                                                                                                                                                                                                                                                                                                                                    |
+|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Getting Started  | 1. Build presto <br/>2. Look for [good first issue](https://github.com/prestodb/presto/labels/good%20first%20issue) tickets. <br/> 3. Reference project boards for open work: https://github.com/prestodb/presto/projects?query=is%3Aopen                                                                                                                                                                    |


Suggested change

| Getting Started | 1. Build presto <br/>2. Look for [good first issue](https://github.com/prestodb/presto/labels/good%20first%20issue) tickets. <br/> 3. Reference project boards for open work: https://github.com/prestodb/presto/projects?query=is%3Aopen |

| Getting Started | 1. Build presto <br/>2. Look for [good first issue](https://github.com/prestodb/presto/labels/good%20first%20issue) tickets. <br/> 3. [Reference project boards for open work](https://github.com/prestodb/presto/projects?query=is%3Aopen). |

steveburnett

Two nits but that's all, I think. Thanks!

CONTRIBUTING.md

tdcmeehan

Thank you @efrancisworks!

Steve is good with this change.

tdcmeehan · 2024-06-05T19:41:27Z

Fixing the rebase conflicts in #22930

efrancisworks requested review from a team and steveburnett as code owners May 13, 2024 04:29

efrancisworks requested a review from presto-oss May 13, 2024 04:29

tdcmeehan self-assigned this May 13, 2024

elharo reviewed May 13, 2024

View reviewed changes

steveburnett requested changes May 13, 2024

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

efrancisworks force-pushed the issue-21736 branch from b3947ee to c35143b Compare May 13, 2024 21:22

efrancisworks commented May 13, 2024

View reviewed changes

CONTRIBUTING.md Show resolved Hide resolved

steveburnett previously approved these changes May 14, 2024

View reviewed changes

tdcmeehan reviewed May 14, 2024

View reviewed changes

efrancisworks dismissed steveburnett’s stale review via bf0ea53 May 16, 2024 05:26

efrancisworks force-pushed the issue-21736 branch from c35143b to bf0ea53 Compare May 16, 2024 05:26

steveburnett requested changes May 21, 2024

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

tdcmeehan reviewed May 22, 2024

View reviewed changes

steveburnett mentioned this pull request May 22, 2024

Identify unowned parts of the repo #22641

Merged

6 tasks

efrancisworks force-pushed the issue-21736 branch from bf0ea53 to 365b43b Compare May 28, 2024 21:56

tdcmeehan reviewed May 28, 2024

View reviewed changes

steveburnett previously requested changes May 29, 2024

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

Added table for users to quickly navigate documentation.

216be11

efrancisworks force-pushed the issue-21736 branch from 365b43b to 216be11 Compare May 29, 2024 23:50

tdcmeehan approved these changes May 30, 2024

View reviewed changes

tdcmeehan mentioned this pull request Jun 5, 2024

Add table for users to quickly navigate documentation #22930

Merged

tdcmeehan closed this Jun 5, 2024

		\| 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) . \|

	\| Getting Started \| 1. Build presto <br/>2. Look for [good first issue](https://github.com/prestodb/presto/labels/good%20first%20issue) tickets. <br/> 3. Reference project boards for open work: https://github.com/prestodb/presto/projects?query=is%3Aopen \|
	\| Getting Started \| 1. Build presto <br/>2. Look for [good first issue](https://github.com/prestodb/presto/labels/good%20first%20issue) tickets. <br/> 3. [Reference project boards for open work](https://github.com/prestodb/presto/projects?query=is%3Aopen). \|

Conversation

efrancisworks commented May 13, 2024

Description

Motivation and Context

Impact

Test Plan

Contributor checklist

Release Notes

Uh oh!

elharo May 13, 2024

Choose a reason for hiding this comment

Uh oh!

elharo May 13, 2024

Choose a reason for hiding this comment

Uh oh!

steveburnett left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

steveburnett left a comment

Choose a reason for hiding this comment

Uh oh!

tdcmeehan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tdcmeehan May 14, 2024

Choose a reason for hiding this comment

Uh oh!

steveburnett commented May 16, 2024

Uh oh!

efrancisworks commented May 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

steveburnett left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tdcmeehan May 22, 2024

Choose a reason for hiding this comment

Uh oh!

tdcmeehan left a comment

Choose a reason for hiding this comment

Uh oh!

tdcmeehan May 28, 2024

Choose a reason for hiding this comment

Uh oh!

steveburnett left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tdcmeehan left a comment

Choose a reason for hiding this comment

Uh oh!

tdcmeehan commented Jun 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tdcmeehan left a comment •

edited

Loading

efrancisworks commented May 21, 2024 •

edited

Loading