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

Fix maintainers #2012

Merged
merged 2 commits into from
Oct 23, 2024
Merged

Fix maintainers #2012

merged 2 commits into from
Oct 23, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Oct 23, 2024

Fixes: #2006

Summary by Sourcery

Update the maintainers' information in the documentation and adjust the Python version requirement. Add a new MAINTAINERS.md file to list current and emeritus team members.

Documentation:

  • Add a 'Current Maintainer' and 'Emeritus Core Team Members' section to the README.md to clarify the roles of contributors.

Chores:

  • Update the Python version requirement from 3.8 to 3.9 in the installation instructions.

Copy link
Contributor

sourcery-ai bot commented Oct 23, 2024

Reviewer's Guide by Sourcery

This pull request updates the README.md file to reorganize the authors section, updates the minimum Python version requirement, and adds a new MAINTAINERS.md file. It also updates the pre-commit configuration.

Class diagram for README.md structure update

classDiagram
    class README {
        +"Current Maintainer"
        +"Emeritus Core Team Members"
        +"Installation"
        +"Documentation"
        +"A simple example"
    }
Loading

Class diagram for MAINTAINERS.md addition

classDiagram
    class MAINTAINERS {
        +"Current Maintainer"
        +"Emeritus Team Members"
    }
Loading

File-Level Changes

Change Details Files
Reorganized the Authors section in the README
  • Added 'Current Maintainer' and 'Emeritus Core Team Members' subsections
  • Moved Vladimir I. Iglovikov to 'Current Maintainer'
  • Moved other authors to 'Emeritus Core Team Members'
  • Removed job titles from author descriptions
  • Fixed a typo in Eugene Khvedchenya's name
README.md
Updated minimum Python version requirement
  • Changed minimum Python version from 3.8 to 3.9
README.md
Added new MAINTAINERS.md file
  • Created a new file listing current maintainer and emeritus team members
MAINTAINERS.md
Updated pre-commit configuration
  • Updated mypy version from v1.12.1 to v1.13.0
.pre-commit-config.yaml
Updated Table of Contents in README
  • Added entries for 'Current Maintainer' and 'Emeritus Core Team Members'
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ternaus - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ternaus ternaus merged commit a212f87 into main Oct 23, 2024
14 checks passed
@ternaus ternaus deleted the fix_maintainers branch October 23, 2024 17:32
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.

Add MAINTAINERS.md
1 participant