ContextQMD
Back to Powershell

Repository Maintainers

docs/maintainers/README.md

7.6.17.0 KB
Original Source

Repository Maintainers

Repository Maintainers are trusted stewards of the PowerShell repository responsible for maintaining consistency and quality of PowerShell code. One of their primary responsibilities is merging pull requests after all requirements have been fulfilled.

They have write access to the PowerShell repositories which gives them the power to:

  1. git push to the official PowerShell repository
  2. Merge pull requests
  3. Assign labels, milestones, and people to issues and pull requests

Table of Contents

Current Repository Maintainers

<!-- please keep in alphabetical order -->

Former Repository Maintainers

<!-- please keep in alphabetical order -->

Repository Maintainer Responsibilities

Repository Maintainers enable rapid contributions while maintaining a high level of quality in PowerShell by ensuring that all development processes are being followed correctly.

If you are a Repository Maintainer, you:

  1. MUST abide by the Code of Conduct and report suspected violations to the PowerShell Committee
  2. MUST ensure that each contributor has signed a valid Microsoft Contributor License Agreement (CLA)
  3. MUST verify compliance with any third party code license terms (e.g., requiring attribution, etc.) if the contribution contains third party code.
  4. MUST make sure that any change requiring approval from the PowerShell Committee has gone through the proper RFC or approval process
  5. MUST validate that code reviews have been conducted before merging a pull request when no code is written
  6. MUST validate that tests and documentation have been written before merging a pull request that contains new functionality
  7. SHOULD add the correct labels to issues and pull requests
  8. SHOULD make sure the correct Area Experts are assigned to relevant pull requests and issues. This includes adding extra reviewers when it makes sense (e.g. a pull request that adds remoting capabilities might require a security expert)
  9. SHOULD validate that the names and email addresses in the git commits reasonably match identity of the person submitting the pull request
  10. SHOULD make sure contributors are following the contributor guidelines
  11. SHOULD ask people to resend a pull request, if it doesn't target master
  12. SHOULD wait for the CI system build to pass for pull requests (unless, for instance, the pull request is being submitted to fix broken CI)
  13. SHOULD encourage contributors to refer to issues in their pull request description (e.g. Resolves issue #123). If a user did not create an issue prior to submitting their pull request, their pull request should not be rejected. However, they should be reminded to create an issue in the future to frontload any potential problems with the work and to minimize duplication of efforts.
  14. SHOULD encourage contributors to create meaningful titles for all PRs. Edit the title if necessary to provide clarity on the problem
  15. SHOULD encourage contributors to write meaningful, descriptive git commits
  16. SHOULD NOT merge pull requests with a failed CI build (unless, for instance, the pull request is being submitted to fix broken CI)
  17. SHOULD NOT merge pull requests without the status check passing from the Microsoft CLA bot (unless the CLA bot is broken, and CLA signing can be confirmed through other means)
  18. SHOULD NOT merge pull requests too quickly after they're submitted. Even if the pull request meets all the requirements, people should have time to give their input (unless the pull request is particularly urgent for some reason)
  19. SHOULD NOT merge your own pull requests. If a Repository Maintainer opens a pull request, another Maintainer should merge it unless there are extreme, short-term circumstances requiring a merge or another Maintainer has given explicit sign-off without merging

Issue Management Process

Please see Issue Management

Pull Request Workflow

Please see Contributing

Maintainer Best Practices

Please see Best Practices

Becoming a Repository Maintainer

Repository Maintainers currently consist mostly of Microsoft employees. It is expected that over time, regular trusted contributors to the PowerShell repository will be made Repository Maintainers. Eligibility is heavily dependent on the level of contribution and expertise: individuals who contribute consistently in meaningful ways to the project will be recognized accordingly.

At any point in time, the existing Repository Maintainers can unanimously nominate a strong community member to become a Repository Maintainer. Nominations are brought to the PowerShell Committee to understand the reasons and justification. A simple majority of the PowerShell Committee is required to veto the nomination. When a nominee has been approved, a PR will be submitted by a current Maintainer to update this document to add the nominee's name to the Current Repository Maintainers with justification as the description of the PR to serve as the public announcement.