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 #47

Merged
merged 1 commit into from
Dec 20, 2024

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Dec 16, 2024

Summary by Sourcery

Revise GitHub configuration files to improve contribution guidelines, update issue templates, and refine CI workflows. Enhance documentation clarity and standardize issue submission processes.

CI:

  • Modify the testPublish.yml workflow to correct the node-version matrix and refine the release conditions.

Documentation:

  • Update the CONTRIBUTING.md file to clarify guidelines for submitting issues and pull requests, including the importance of consulting with the Auro team before starting work.
  • Revise the CODE_OF_CONDUCT.md to improve clarity and ensure it aligns with the Contributor Covenant.
  • Add new issue templates for feature requests and general support to standardize submissions.

Copy link

sourcery-ai bot commented Dec 16, 2024

Reviewer's Guide by Sourcery

This PR implements various GitHub configuration changes and updates across multiple files. The changes primarily focus on improving documentation, updating issue templates, and refining repository settings. The modifications include better formatting, clearer instructions for contributors, and standardized team permissions.

Class diagram for GitHub configuration changes

classDiagram
    class Repository {
        +String homepage
        +Boolean allow_rebase_merge
        +List~Team~ teams
    }
    class Team {
        +String name
        +String permission
    }
    Repository "1" -- "*" Team : has
    note for Repository "Updated repository settings with new team permissions and homepage URL."
Loading

File-Level Changes

Change Details Files
Enhanced contributing guidelines with clearer formatting and additional details
  • Added detailed commit message format guidelines
  • Clarified the process for submitting issues and pull requests
  • Updated instructions for repository maintainers and trusted committers
  • Added examples of proper commit messages with descriptions
.github/CONTRIBUTING.md
Updated repository settings and team permissions configuration
  • Reorganized team permissions section for better readability
  • Updated branch protection rules
  • Removed redundant repository description
.github/settings.yml
Modernized issue templates and configuration
  • Added new YAML-based issue templates for feature requests and general support
  • Updated issue template configuration
  • Added CODEOWNERS file
.github/ISSUE_TEMPLATE/config.yml
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
.github/CODEOWNERS
Improved CI/CD workflow configurations
  • Fixed node version specification in test and publish workflow
  • Updated conditional statement for release job
  • Cleaned up workflow file formatting
.github/workflows/testPublish.yml
.github/workflows/publishDemo.yml
.github/workflows/codeql.yml

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

Surge demo deployment failed! 😭

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 - here's some feedback:

Overall Comments:

  • Could you explain the rationale for removing the demo files (api.md, api.min.js, index.md, index.min.js)? These seem like potentially important files for the component.
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.

@jason-capsule42 jason-capsule42 merged commit ff27c36 into main Dec 20, 2024
6 of 7 checks passed
@jason-capsule42 jason-capsule42 deleted the migration/github-config-and-gitignore-changes branch December 20, 2024 20:26
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.1.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Dec 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants