-
Notifications
You must be signed in to change notification settings - Fork 101
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
Introduce our code culture in contributing.md #1096
Conversation
Looks good! Thank you! |
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.
Some nits but an otherwise great start 🚢
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.
I like zen-dog's suggestions but this is better than what as there! nice!
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!
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, minor nits along with the existing suggestions.
CONTRIBUTING.md
Outdated
- Every user-facing feature that is NOT behind a feature gate should have an integration test | ||
|
||
### Pull requests | ||
- One core-team member has to approve the PR to be able to merge (defined in code owners file) |
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 core-team member has to approve the PR to be able to merge (defined in code owners file) | |
- One code owner has to approve the PR to be able to merge. |
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.
What is "an owner"? The OWNERS
file only has approvers
and reviewers
.
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.
Let's delete OWNERS until when/if we go back to Prow. CODEOWNERS only has the concept of an owner.
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.
I think they are still valuable because github assigns PRs based on them. I still feel like they are a meaningful definition of what we consider a "core-team member"
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.
I've rephrased it a bit @porridge let me know if that works for you
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 with suggestions applied.
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 overall, but I'd like some more clarity on the "issue required" point.
CONTRIBUTING.md
Outdated
- Every user-facing feature that is NOT behind a feature gate should have an integration test | ||
|
||
### Pull requests | ||
- One core-team member has to approve the PR to be able to merge (defined in code owners file) |
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.
What is "an owner"? The OWNERS
file only has approvers
and reviewers
.
CONTRIBUTING.md
Outdated
### Pull requests | ||
- One core-team member has to approve the PR to be able to merge (defined in code owners file) | ||
- When core-team member puts 'request for changes' on your PR, that stops merging until it's resolved (even when have enough approvals) | ||
- Since KUDO is developed in multiple timezones, try to keep the PR open for everyone to be able to see it (~24h) |
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.
Should we mention public holidays?
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.
Do we need to be explicit? I like guidelines/light rules :) we're fairly senior team right now, I would be ok with letting everyone interpret what does it mean for the other timezone to see their code :) but I can surely add it if you feel like it helps
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.
Agreed, I'm 👍 on not needing to be explicit here...I think the intent of the culture is giving opportunities to others, and as long as we carry that intent, we can all be roughly on the same page. Just something to keep in mind before you hit that squash and merge button - have there been opportunities for my fellow KUDO developers to review this? If I'm merging without, am I justifying why this needs to be in without giving that opportunity (say, a bug fix before people in US times have had a chance to see it), etc. Nothing hard and fast.
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.
I don't mean enumerating holidays, I'm also all for loose guidelines.
I thought about this as a helpful hint, because personally I often forget that people on the other side of the globe might be away for a while.
The mention of just 24h
here would further cement my conviction that passage of time is equivalent to providing such opportunities for review.
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 @alenkacz!
Co-Authored-By: Marcin Owsiany <marcin@owsiany.pl>
Co-Authored-By: Marcin Owsiany <marcin@owsiany.pl>
Co-Authored-By: Aleksey Dukhovniy <adukhovniy@mesosphere.io>
Co-Authored-By: Aleksey Dukhovniy <adukhovniy@mesosphere.io>
Co-Authored-By: Aleksey Dukhovniy <adukhovniy@mesosphere.io>
Co-Authored-By: Aleksey Dukhovniy <adukhovniy@mesosphere.io>
Co-Authored-By: Matthias Eichstedt <matthias.eichstedt@mesosphere.io>
What this PR does / why we need it:
This is a first outline of our code culture that mostly came out of retrospectives we had in the last 2 months.
This is for sure not a definitive list, let's add more points in next PRs though. Let's make this PR just about the points mentioned and if everyone is OK with them and with the wording.
Please let's keep this PR open longer so that everyone have chance to see it.