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

Update contribution guide #2130

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Conversation

zimnx
Copy link
Collaborator

@zimnx zimnx commented Sep 25, 2024

Our contribution guide is very outdated and recommends style we don't use anymore. Content was updated to follow our existing style and lays out a coding convention and code review standard.

@zimnx zimnx added kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Sep 25, 2024
@scylla-operator-bot scylla-operator-bot bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 25, 2024
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zimnx

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@scylla-operator-bot scylla-operator-bot bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 25, 2024
Copy link
Member

@rzetelskik rzetelskik left a comment

Choose a reason for hiding this comment

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

Leaving some suggestions for changes in wording, take the ones addressing style and conciseness rather than substance as mostly optional. I'm yet to look at the proposed guides

docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
Copy link
Contributor

@tnozicka tnozicka left a comment

Choose a reason for hiding this comment

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

I am yet to go through the referenced documents, but I'd personally not couple fixing the existing practices and introducing new rules.

docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
Copy link
Contributor

The Scylla Operator project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 30d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out

/lifecycle stale

@scylla-operator-bot scylla-operator-bot bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 3, 2024
@zimnx
Copy link
Collaborator Author

zimnx commented Nov 4, 2024

/remove-lifecycle stale

@scylla-operator-bot scylla-operator-bot bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 4, 2024
@scylla-operator-bot scylla-operator-bot bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 25, 2024
@rzetelskik
Copy link
Member

rzetelskik commented Dec 20, 2024

We should speed this one up, we don't have any contribution guide atm, and we also need to remove/update the references: #2291 (comment). Perhaps we could just add this as CONTRIBUTING.md at the top level?

@rzetelskik rzetelskik mentioned this pull request Jan 8, 2025
@scylla-operator-bot scylla-operator-bot bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 10, 2025
Copy link
Contributor

scylla-operator-bot bot commented Jan 10, 2025

@zimnx: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-gke-multi-datacenter-parallel bd7b9e2 link true /test e2e-gke-multi-datacenter-parallel

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@mflendrich mflendrich requested a review from rzetelskik January 10, 2025 17:52
@mflendrich
Copy link
Collaborator

/cc rzetelskik zimnx

Copy link
Contributor

@mflendrich: GitHub didn't allow me to request PR reviews from the following users: zimnx.

Note that only scylladb members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc rzetelskik zimnx

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

docs/source/contributing.md Outdated Show resolved Hide resolved
docs/source/contributing.md Outdated Show resolved Hide resolved
Copy link
Member

@rzetelskik rzetelskik left a comment

Choose a reason for hiding this comment

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

@mflendrich please try to keep the commits squashed (we try to avoid changes to the same file in multiple commits)
We also leave conversation resolution to the reviewers, otherwise it's hard to track if they were addressed

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
deleted in 1fbdf03

Update contribution guide

Our contribution guide is very outdated and recommends style we don't use anymore.
Content was updated to follow our existing style and lays out a coding convention and code review standard.

Apply suggestions from code review

Co-authored-by: Kacper Rzetelski <[email protected]>
@mflendrich
Copy link
Collaborator

Please review again.

A style guide is one of those things that can easily produce diminishing returns work. Let's get one in place and then tackle individual improvements in targetted, narrow, easy to review PRs.

One such improvement I'd definitely like to see is cutting the length at least by 50%. But let's pick our battles for now.

@rzetelskik
Copy link
Member

A style guide is one of those things that can easily produce diminishing returns work. Let's get one in place and then tackle individual improvements in targetted, narrow, easy to review PRs.

While I agree with the sentiment, this usually leads to just never getting back to it.
There is one unaddressed comment remaining, rest lgtm.

Update CONTRIBUTING.md

Co-authored-by: Kacper Rzetelski <[email protected]>
@mflendrich
Copy link
Collaborator

Thanks @rzetelskik. PTAL now ☝️ 🙇

@rzetelskik
Copy link
Member

thanks, lgtm
/assign zimnx

Copy link
Collaborator Author

@zimnx zimnx left a comment

Choose a reason for hiding this comment

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

lgtm

@rzetelskik
Copy link
Member

/lgtm

@scylla-operator-bot scylla-operator-bot bot added the lgtm Indicates that a PR is ready to be merged. label Jan 15, 2025
@scylla-operator-bot scylla-operator-bot bot merged commit e8ac0ed into scylladb:master Jan 15, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants