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

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, streamline code of conduct, and enhance issue templates. Update CI workflows to refine release conditions and introduce a new demo deployment workflow.

CI:

  • Modify the testPublish.yml workflow to ensure it only releases on push to main or beta branches, and update the node version specification.

Deployment:

  • Introduce a new workflow publishDemo.yml to automate the deployment of demos on pull requests to the main branch.

Documentation:

  • Update the CONTRIBUTING.md to clarify guidelines for submitting issues and pull requests, emphasizing the importance of consulting with the Auro team before starting work.
  • Revise the CODE_OF_CONDUCT.md to streamline the language and remove specific contact details for reporting issues.
  • Enhance the ISSUE_TEMPLATE for feature requests and general support by adding a section for exit criteria.

@rmenner rmenner requested a review from a team as a code owner December 16, 2024 17:02
Copy link

sourcery-ai bot commented Dec 16, 2024

Reviewer's Guide by Sourcery

This PR implements various GitHub configuration changes across multiple files, focusing on improving documentation, issue templates, and repository settings. The changes include updates to contribution guidelines, code of conduct, PR templates, and GitHub Actions workflows.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Enhanced contribution guidelines with clearer commit message formatting and standards
  • Added detailed commit message format structure with header, body, and footer sections
  • Clarified character length limits for commit messages
  • Added examples of commit message descriptions
  • Updated instructions for commit prefixes and their impact on versioning
.github/CONTRIBUTING.md
Updated repository settings and team permissions configuration
  • Added color codes for issue labels
  • Reorganized team permissions section
  • Updated repository topics
  • Added new label configurations
.github/settings.yml
Enhanced issue templates with exit criteria
  • Added exit criteria section to feature request template
  • Added exit criteria section to general support template
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
Added new GitHub Actions workflow for demo deployment
  • Created new workflow for deploying demos on pull requests
  • Added surge token configuration
.github/workflows/publishDemo.yml
Improved GitHub Actions workflow configurations
  • Fixed branch condition syntax in test and publish workflow
  • Updated Node.js version specification
.github/workflows/testPublish.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

@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:

  • Several demo files have been removed (.md and .min.js files). Can you confirm this was intentional and won't impact the project's documentation or examples?
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

Surge demo deployment failed! 😭

@jason-capsule42 jason-capsule42 merged commit 85f5a66 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:30
@blackfalcon
Copy link
Member

🎉 This PR is included in version 2.3.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Dec 20, 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