Skip to content

Conversation

@ryanzhang-oss
Copy link
Contributor

Description of your changes

add the governance and other improvements on the repo

Fixes #

I have:

  • Run make reviewable to ensure this PR is ready for review.

How has this code been tested

Special notes for your reviewer

@kaito-pr-agent
Copy link

kaito-pr-agent bot commented Mar 27, 2025

Title

(Describe updated until commit 13d1fe8)

docs: add the governance and other improvements


User description

Description of your changes

add the governance and other improvements on the repo

Fixes #

I have:

  • Run make reviewable to ensure this PR is ready for review.

How has this code been tested

Special notes for your reviewer


PR Type

Enhancement


Description

  • Added a comprehensive governance document outlining project values, roles, and processes.

  • Updated the MAINTAINERS.md file to include organization affiliations.

  • Modified the README.md to reflect the project's affiliation with the Cloud Native Computing Foundation (CNCF).

  • Enhanced the ROADMAP.md with additional support items including job dispatching and identity federation.


Changes walkthrough 📝

Relevant files
Documentation
GOVERNANCE.md
Add project governance model                                                         

GOVERNANCE.md

  • Created a detailed governance document covering project values, roles,
    and processes.
  • +161/-0 
    MAINTAINERS.md
    Update maintainers with organization info                               

    MAINTAINERS.md

    • Updated the maintainers list to include organization affiliations.
    +5/-9     
    README.md
    Update README for CNCF affiliation                                             

    README.md

  • Updated the README to reflect the project's affiliation with CNCF.
  • Removed codecov badge and added Slack join link.
  • +12/-78 
    ROADMAP.md
    Enhance roadmap with new support items                                     

    ROADMAP.md

  • Expanded the roadmap with new support items including job dispatching
    and identity federation.
  • +6/-2     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @kaito-pr-agent
    Copy link

    kaito-pr-agent bot commented Mar 27, 2025

    PR Reviewer Guide 🔍

    (Review updated until commit 13d1fe8)

    Here are some key observations to aid the review process:

     Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    @kaito-pr-agent
    Copy link

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Verify the Code of Conduct link is correct

    Ensure the link to the Code of Conduct is accurate and accessible.

    GOVERNANCE.md [135]

    +## Code of Conduct
    +[Code of Conduct](./code-of-conduct.md)
    +violations by community members will be discussed and resolved
    +on the [private Maintainer mailing list](https://groups.google.com/g/kubefleet-dev-private).  If a Maintainer is directly involved
    +in the report, the Maintainers will instead designate two Maintainers to work
    +with the CNCF Code of Conduct Committee in resolving it.
     
    -
    Suggestion importance[1-10]: 3

    __

    Why: The suggestion is not actionable and only asks to verify the link, which is not a valid code suggestion.

    Low
    Remove unused Concepts section

    Remove unused section.

    README.md [27]

    -## Concepts
    +## Quick Start
    Suggestion importance[1-10]: 3

    __

    Why: The suggestion is not actionable and only asks to remove the unused Concepts section, which is not a valid code suggestion.

    Low
    Add a contact section

    Add a contact section.

    README.md [23]

    +## Contact
    +If you have questions, feel free to reach out to us in the following ways:
    +- [mailing list](https://groups.google.com/g/kubefleet-dev)
    +- [slack](https://cloud-native.slack.com/archives/C08KR7589R8) | [Join](https://slack.cncf.io/)
     ## Support
     For more information, see [SUPPORT.md](SUPPORT.md).
    Suggestion importance[1-10]: 3

    __

    Why: The suggestion is not actionable and only asks to add a contact section, which is not a valid code suggestion.

    Low

    GOVERNANCE.md Outdated
    periodically the Maintainers may need to vote on specific actions or changes.
    A vote can be taken on [the developer mailing list](https://groups.google.com/g/kubefleet-dev) or
    [the private Maintainer mailing list](https://groups.google.com/g/kubefleet-dev-private) for security or conduct matters.
    Votes may also be taken at [the developer meeting]. Any Maintainer may
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    nit

    Suggested change
    Votes may also be taken at [the developer meeting]. Any Maintainer may
    Votes may also be taken at [the developer meeting](#meetings). Any Maintainer may

    - [slack](https://cloud-native.slack.com/archives/C08KR7589R8) | [Join](https://slack.cncf.io/)


    [1]: https://img.shields.io/github/v/release/Azure/fleet
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Should this still link to the releases on the Azure github?

    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Is there a reason why these links are still on here?

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    we need something for now, will replace it when we have kubefleet release

    [2]: https://goreportcard.com/badge/go.goms.io/fleet
    [3]: https://goreportcard.com/report/go.goms.io/fleet
    [4]: https://codecov.io/gh/Azure/fleet/branch/main/graph/badge.svg?token=D3mtbzACjC
    [5]: https://img.shields.io/github/go-mod/go-version/Azure/fleet
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Still linked to azure github as well.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    are the goreport about Azure fleet or Kubefleet?

    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    The go report I am not sure. I was mainly referencing the links that include "Azure" in it, but I think these links should be okay for now.

    @kaito-pr-agent
    Copy link

    Persistent review updated to latest commit 54ce0bd

    @jwtty
    Copy link
    Collaborator

    jwtty commented Mar 31, 2025

    LGTM

    Copy link
    Collaborator

    @britaniar britaniar left a comment

    Choose a reason for hiding this comment

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

    LGTM

    @ryanzhang-oss ryanzhang-oss changed the title doc: add the governance and other improvements docs: add the governance and other improvements Mar 31, 2025
    Signed-off-by: Ryan Zhang <zhangryan@microsoft.com>
    @kaito-pr-agent
    Copy link

    Persistent review updated to latest commit 13d1fe8

    @zhiying-lin zhiying-lin merged commit 451f0a1 into kubefleet-dev:main Apr 1, 2025
    6 checks passed
    britaniar pushed a commit to britaniar/kubefleet that referenced this pull request Apr 15, 2025
    Signed-off-by: Ryan Zhang <zhangryan@microsoft.com>
    Co-authored-by: Ryan Zhang <zhangryan@microsoft.com>
    
    update placement status metric
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants