Skip to content
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

docs: Sustainability effort (Incentive system) #12359

Merged
merged 89 commits into from
Jan 4, 2024

Conversation

juliev0
Copy link
Contributor

@juliev0 juliev0 commented Dec 13, 2023

Fixes #12229

Motivation

Current Reviewers and Approvers are struggling to review all of the incoming PRs, and contributors are frustrated that their PRs aren't getting seen. There are a small number of active Reviewers and Approvers, which creates risk long term as well as company priorities change and there's employee turnover.

Also, high priority bugs aren't getting addressed.

The thought is that an incentive system could increase the level of activity for both and help turn Argo Workflows into a more sustainable system.

Verification

I'd like to get many eyeballs on this. For anyone that might be interested, please consider the terms and provide feedback if it doesn't seem right. Thank you!

Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
@juliev0 juliev0 changed the title Sustainability effort (Incentive system) feat: Sustainability effort (Incentive system) Dec 13, 2023
Copy link
Member

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for driving this! I like the tangible list of items for contributors to participate!

community/sustainability_effort.md Outdated Show resolved Hide resolved
community/sustainability_effort.md Outdated Show resolved Hide resolved
community/sustainability_effort.md Outdated Show resolved Hide resolved
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
@juliev0
Copy link
Contributor Author

juliev0 commented Dec 15, 2023

@shuangkun you mentioned in the original issue that you'd be interested in participating in this. Do the terms laid out here seem okay to you?

@shuangkun
Copy link
Member

@shuangkun you mentioned in the original issue that you'd be interested in participating in this. Do the terms laid out here seem okay to you?

It‘s okay for me. I am interested in getting more involved in community-related work.

Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
@juliev0
Copy link
Contributor Author

juliev0 commented Dec 16, 2023

@shuangkun you mentioned in the original issue that you'd be interested in participating in this. Do the terms laid out here seem okay to you?

It‘s okay for me. I am interested in getting more involved in community-related work.

Great, in that case I've added you to the PR.

Copy link
Member

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Primarily lots of stylistic changes, though a few structural points, such as moving some sections into the Contributing docs as they are not specific to the Incentive System

feat: Sustainability effort (Incentive system)

Also this would be a docs: PR

community/sustainability_effort.md Outdated Show resolved Hide resolved
community/sustainability_effort.md Outdated Show resolved Hide resolved
community/sustainability_effort.md Outdated Show resolved Hide resolved
community/sustainability_effort.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/enhancement_proposal.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/regression.yaml Outdated Show resolved Hide resolved
USERS.md Outdated Show resolved Hide resolved
community/README.md Outdated Show resolved Hide resolved
community/README.md Outdated Show resolved Hide resolved
@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Dec 18, 2023
@terrytangyuan
Copy link
Member

Should we just call this something like triaging/maintenance guidelines instead of sustainability effort?

Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Copy link
Member

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you for driving this effort!

Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Copy link
Member

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few small comments, otherwise LGTM

docs/CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/CONTRIBUTING.md Outdated Show resolved Hide resolved
community/sustainability_effort.md Outdated Show resolved Hide resolved
community/sustainability_effort.md Outdated Show resolved Hide resolved
community/sustainability_effort.md Outdated Show resolved Hide resolved
community/sustainability_effort.md Outdated Show resolved Hide resolved
.spelling Outdated Show resolved Hide resolved

Current roles for Reviewers and above can be found in [OWNERS](../OWNERS).

If you are interested in formally joining the Argo project, [create a Membership request](https://github.com/argoproj/argoproj/issues/new?template=membership.md&title=REQUEST%3A%20New%20membership%20for%20%3Cyour-GH-handle%3E) in the [argoproj](https://github.com/argoproj/argoproj) repository as described in the [Membership](https://github.com/argoproj/argoproj/blob/main/community/membership.md) guide.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you are interested in formally joining the Argo project, [create a Membership request](https://github.com/argoproj/argoproj/issues/new?template=membership.md&title=REQUEST%3A%20New%20membership%20for%20%3Cyour-GH-handle%3E) in the [argoproj](https://github.com/argoproj/argoproj) repository as described in the [Membership](https://github.com/argoproj/argoproj/blob/main/community/membership.md) guide.
If you are interested in formally joining the Argo project, [create a Membership request](https://github.com/argoproj/argoproj/issues/new?template=membership.md&title=REQUEST%3A%20New%20membership%20for%20%3Cyour-GH-handle%3E) in the [`argoproj` repository](https://github.com/argoproj/argoproj) as described in the [Membership](https://github.com/argoproj/argoproj/blob/main/community/membership.md) guide.

we could put argoproj in backticks, and then we could remove it from the .spelling. nbd either way though, up to you

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll just leave as is

community/sustainability_effort.md Outdated Show resolved Hide resolved
community/sustainability_effort.md Outdated Show resolved Hide resolved
@agilgur5
Copy link
Member

agilgur5 commented Jan 4, 2024

Also I still think we should change the PR title prefix from feat: to docs:

juliev0 and others added 9 commits January 4, 2024 11:21
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
@juliev0 juliev0 changed the title feat: Sustainability effort (Incentive system) docs: Sustainability effort (Incentive system) Jan 4, 2024
Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
@agilgur5
Copy link
Member

agilgur5 commented Jan 4, 2024

I think the docs build is failing because the two relative links its erroring on are outside of the docs/ folder. So we'll have to make those absolute links I guess

@juliev0
Copy link
Contributor Author

juliev0 commented Jan 4, 2024

I think the docs build is failing because the two relative links its erroring on are outside of the docs/ folder. So we'll have to make those absolute links I guess

Thanks for figuring out the cause. I'll make them absolute.

Signed-off-by: Julie Vogelman <julievogelman0@gmail.com>
Copy link
Member

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀 Great work on this Julie! Lots of great improvements to the Contributing docs here plus the incentive system 🙂

@juliev0
Copy link
Contributor Author

juliev0 commented Jan 4, 2024

🚀 Great work on this Julie! Lots of great improvements to the Contributing docs here plus the incentive system 🙂

thanks for the doc improvements!

@juliev0 juliev0 merged commit a6b1217 into argoproj:main Jan 4, 2024
15 checks passed
@juliev0 juliev0 deleted the incentive-system branch January 4, 2024 20:57
@agilgur5 agilgur5 added the area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix label Feb 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incentive system to increase community involvement and ultimately bring in more Reviewers and Approvers
4 participants