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

Introduce our code culture in contributing.md #1096

Merged
merged 10 commits into from
Nov 28, 2019
Merged

Conversation

alenkacz
Copy link
Contributor

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.

@gerred
Copy link
Member

gerred commented Nov 21, 2019

Looks good! Thank you!

Copy link
Contributor

@zen-dog zen-dog left a 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 🚢

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
Copy link
Member

@kensipe kensipe left a 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!

Copy link
Member

@zmalik zmalik left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@meichstedt meichstedt left a 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 Show resolved Hide resolved
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)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- 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.

Copy link
Member

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.

Copy link
Member

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.

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 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"

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've rephrased it a bit @porridge let me know if that works for you

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@nfnt nfnt left a 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.

Copy link
Member

@porridge porridge left a 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 Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
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)
Copy link
Member

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)
Copy link
Member

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?

Copy link
Contributor Author

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

Copy link
Member

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.

Copy link
Member

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.

Copy link
Member

@mpereira mpereira left a comment

Choose a reason for hiding this comment

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

Thanks @alenkacz!

alenkacz and others added 9 commits November 27, 2019 18:47
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>
@alenkacz alenkacz merged commit d80753e into master Nov 28, 2019
@alenkacz alenkacz deleted the av/code-culture branch November 28, 2019 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants