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

MULTI-GITTER PR: migration github-config-and-gitignore-changes #240

Merged
merged 1 commit into from
Dec 26, 2024

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Dec 12, 2024

Summary by Sourcery

Revise documentation and GitHub configuration files to improve clarity and update settings. Modify CI workflows to use abstract node versions for testing. Update repository settings to include new team permissions and label colors.

Enhancements:

  • Update GitHub repository settings to include new team permissions and label colors.

CI:

  • Modify GitHub Actions workflow to use abstract node versions for testing.

Documentation:

  • Revise CONTRIBUTING.md and CODE_OF_CONDUCT.md for clarity and updated guidelines.

@rmenner rmenner requested a review from a team as a code owner December 12, 2024 04:47
Copy link

sourcery-ai bot commented Dec 12, 2024

Reviewer's Guide by Sourcery

This PR updates various GitHub configuration files and documentation to align with current standards. The changes primarily focus on improving contribution guidelines, updating issue templates, and standardizing repository settings.

Class diagram for GitHub configuration changes

classDiagram
    class RepositorySettings {
        - description: String
        - homepage: String
        - topics: List<String>
        - has_issues: Boolean
        - allow_rebase_merge: Boolean
        + teams: List<Team>
        + branches: List<Branch>
        + labels: List<Label>
    }

    class Team {
        - name: String
        - permission: String
    }

    class Branch {
        - name: String
        - protection: Protection
    }

    class Protection {
        - required_status_checks: StatusChecks
        - enforce_admins: Boolean
        - restrictions: Restrictions
    }

    class StatusChecks {
        - strict: Boolean
        - contexts: List<String>
    }

    class Restrictions {
        - users: List<String>
        - teams: List<String>
    }

    class Label {
        - name: String
        - color: String
        - description: String
        - aliases: List<String>
    }

    RepositorySettings --> Team
    RepositorySettings --> Branch
    RepositorySettings --> Label
    Branch --> Protection
    Protection --> StatusChecks
    Protection --> Restrictions
Loading

File-Level Changes

Change Details Files
Enhanced contribution guidelines with clearer instructions and formatting
  • Added detailed commit message format guidelines
  • Clarified pull request submission process
  • Updated rebase instructions and best practices
  • Added examples for commit message descriptions
.github/CONTRIBUTING.md
Updated repository settings and team permissions configuration
  • Reorganized team permissions section
  • Added color codes for issue labels
  • Updated branch protection rules
  • Modified repository description and topics
.github/settings.yml
Improved issue templates and workflows
  • Updated label references in issue templates
  • Modified test workflow to use abstract node versions
  • Added new publishDemo workflow
  • Updated CodeQL workflow configuration
.github/ISSUE_TEMPLATE/bug_report.yml
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
.github/workflows/testPublish.yml
.github/workflows/codeql.yml
.github/workflows/publishDemo.yml
Updated code of conduct with revised enforcement section
  • Removed specific contact email
  • Reformatted document structure
  • Updated enforcement guidelines
.github/CODE_OF_CONDUCT.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

@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 @rmenner - 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.

Copy link

github-actions bot commented Dec 13, 2024

Surge demo deployment failed! 😭

@rmenner rmenner force-pushed the migration/github-config-and-gitignore-changes branch from d5226ca to 8ddc646 Compare December 26, 2024 18:24
@rmenner rmenner merged commit 92a7c81 into main Dec 26, 2024
6 of 7 checks passed
@rmenner rmenner deleted the migration/github-config-and-gitignore-changes branch December 26, 2024 18:48
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.

2 participants