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

Merged
merged 3 commits into from
Dec 26, 2024

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Dec 16, 2024

Summary by Sourcery

Migrate branch references from 'master' to 'main' in documentation, configuration, and CI workflows. Enhance issue templates with exit criteria sections and update procedural instructions in contributing guidelines.

Enhancements:

  • Update branch references from 'master' to 'main' across various documentation and configuration files to align with modern naming conventions.

CI:

  • Modify GitHub Actions workflows to trigger on the 'main' branch instead of 'master', ensuring CI processes are aligned with the updated branch naming.

Documentation:

  • Revise the CONTRIBUTING.md and CODE_OF_CONDUCT.md files to improve clarity and update procedural instructions.
  • Add exit criteria sections to issue templates to better define closure conditions for issues.

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

sourcery-ai bot commented Dec 16, 2024

Reviewer's Guide by Sourcery

This PR implements several repository configuration changes, primarily focusing on standardizing GitHub-related files and configurations. The changes include updating branch naming from 'master' to 'main', enhancing documentation clarity, and improving issue templates with additional fields.

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

File-Level Changes

Change Details Files
Update branch naming convention from 'master' to 'main'
  • Update all references in documentation and workflows
  • Modify branch protection rules
  • Update CI/CD pipeline configurations
.github/CONTRIBUTING.md
.github/settings.yml
.github/workflows/testPublish.yml
.github/workflows/codeql.yml
Enhance documentation and contribution guidelines
  • Improve commit message format documentation
  • Add detailed examples for commit messages
  • Clarify repository access permissions
  • Update issue submission guidelines
.github/CONTRIBUTING.md
.github/CODE_OF_CONDUCT.md
Improve issue templates and GitHub configuration
  • Add exit criteria field to issue templates
  • Update stale issue configuration
  • Add demo publishing workflow
  • Remove unused demo files
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
.github/stale.yml
.github/workflows/publishDemo.yml
demo/api.md
demo/api.min.js
demo/index.md
demo/index.min.js

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.

@rmenner rmenner force-pushed the migration/github-config-and-gitignore-changes branch from 45debf2 to 7954398 Compare December 26, 2024 18:27
@rmenner rmenner changed the base branch from master to main December 26, 2024 18:31
DukeFerdinand
DukeFerdinand previously approved these changes Dec 26, 2024
Copy link

github-actions bot commented Dec 26, 2024

Surge demo deployment failed! 😭

@rmenner rmenner merged commit 5f50686 into main Dec 26, 2024
6 of 7 checks passed
@rmenner rmenner deleted the migration/github-config-and-gitignore-changes branch December 26, 2024 22:14
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