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

first pass at a code of conduct #1576

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

weshayutin
Copy link
Contributor

Why the changes were made

Scott made me realize that I had not properly socialized my thoughts on overriding prow jobs. So I thought I'd take a moment and write my thoughts on how to conduct ourselves with PR's and Issues.

How to test the changes made

No testing, but open to discussion and evolving changes.

@weshayutin
Copy link
Contributor Author

/hold

@weshayutin weshayutin self-assigned this Oct 25, 2024
@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 25, 2024
docs/developer/Code_of_Conduct.md Outdated Show resolved Hide resolved

### Pull Request guidelines
1. Follow the PR template instructions.
1. Avoid self overrides. If prow tests are failing, ask the reviewers to override tests if needed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we also want to address when overrides are appropriate, at least in part? Something like "Always allow a required test to run and fail first before overriding" if we want to make a hard rule there. Otherwise, "Never override unless we expect the test to fail consistently."

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 we should have the discussion first. Not sure if I'm right, but IMHO I said someone that is currently on the CI team should look at the failure and override. This way we can catch the repeat issues and appropriately add to @mpryc 's retry mechanism. Open for discussion and clarifying

Copy link
Contributor

Choose a reason for hiding this comment

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

can we enforce who can override through 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.

@mateusoliveira43 The enforcement we're talking about here isn't for users who shouldn't be in OWNERS, though. i.e. if someone who is an owner submits a PR, that person shouldn't override. I guess the real question is whether the prow bot can enforce rules like "don't allow /override from author".

@mpryc
Copy link
Contributor

mpryc commented Nov 5, 2024

@mpryc please review.

@mpryc
Copy link
Contributor

mpryc commented Nov 5, 2024

@weshayutin your branch I think is way behind oadp-operator master so it was hard for me to create PR against your branch :)

Here is patch:
weshayutin@b8b5c85

Copy link
Member

@kaovilai kaovilai left a comment

Choose a reason for hiding this comment

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

Suggestions from @mpryc in github suggestions format.

docs/developer/Code_of_Conduct.md Outdated Show resolved Hide resolved
docs/developer/Code_of_Conduct.md Outdated Show resolved Hide resolved
docs/developer/Code_of_Conduct.md Outdated Show resolved Hide resolved
docs/developer/Code_of_Conduct.md Outdated Show resolved Hide resolved
docs/developer/Code_of_Conduct.md Outdated Show resolved Hide resolved
docs/developer/Code_of_Conduct.md Outdated Show resolved Hide resolved
kaovilai
kaovilai previously approved these changes Nov 5, 2024
@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 5, 2024
@weshayutin weshayutin removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 8, 2024
@weshayutin
Copy link
Contributor Author

@sseago @kaovilai or anyone for the name of the file.. would "Development Conduct Guidelines" be better than "code of conduct"?

  • Development Guidelines
  • How we work together
  • Non Technical Developer Best Practices
  • Help me out w/ a name. names are hard

@mateusoliveira43
Copy link
Contributor

mateusoliveira43 commented Nov 8, 2024

current name is better because of https://github.com/openshift/oadp-operator/community

(but I think it needs to be in root of in docs/ folder, it is current in docs/developer/ folder)

@kaovilai
Copy link
Member

kaovilai commented Nov 8, 2024

How we devs work together in PRs sounds more like Contributing.md more so that Code of conduct.

Code of conduct is like behavioral rules unrelated to code contributions which should not include PR conventions.

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md

@kaovilai
Copy link
Member

kaovilai commented Nov 8, 2024

The content of currend .md is a combination of both.

I would suggest splitting into two.

Ones for technical guidelines. Contributing.md
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
One for behavioral. Code of conduct.md
https://opensource.guide/code-of-conduct/

@kaovilai
Copy link
Member

kaovilai commented Nov 8, 2024

Writing your contributing guidelines

A CONTRIBUTING file tells your audience how to participate in your project. For example, you might include information on:

How to file a bug report (try using issue and pull request templates)
How to suggest a new feature
How to set up your environment and run tests
In addition to technical details, a CONTRIBUTING file is an opportunity to communicate your expectations for contributions, such as:

The types of contributions you’re looking for
Your roadmap or vision for the project
How contributors should (or should not) get in touch with you

Establishing a code of conduct

Finally, a code of conduct helps set ground rules for behavior for your project’s participants. This is especially valuable if you’re launching an open source project for a community or company. A code of conduct empowers you to facilitate healthy, constructive community behavior, which will reduce your stress as a maintainer.

For more information, check out our Code of Conduct guide.

@kaovilai
Copy link
Member

kaovilai commented Nov 8, 2024

Copy link

openshift-ci bot commented Nov 8, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mpryc, weshayutin

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

1 similar comment
Copy link

openshift-ci bot commented Nov 8, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mpryc, weshayutin

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

@weshayutin
Copy link
Contributor Author

contributing - #1586
code of conduct - #1576

@weshayutin weshayutin mentioned this pull request Nov 8, 2024
Copy link

openshift-ci bot commented Nov 8, 2024

@weshayutin: all tests passed!

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.

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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants