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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rmenner
Copy link

@rmenner rmenner commented Dec 16, 2024

Summary by Sourcery

Revise GitHub configuration files to improve contribution guidelines, issue templates, and CI workflows. Enhance documentation for contributors and streamline the process for submitting issues and pull requests. Introduce a new workflow for deploying demo environments.

CI:

  • Modify the testPublish.yml workflow to refine the conditions for triggering releases on push events.
  • Introduce a new publishDemo.yml workflow to automate the deployment of demo environments on pull requests to the main branch.

Documentation:

  • Update the CONTRIBUTING.md file to include additional guidelines for Alaska Airlines employees and clarify the process for submitting issues and pull requests.
  • Revise the CODE_OF_CONDUCT.md to streamline the language and remove specific contact details for reporting issues.
  • Add new ISSUE_TEMPLATE files for feature requests and general support, enhancing the structure for submitting different types of issues.

@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 updates various GitHub configuration files and templates to improve repository management and contribution processes. The changes focus on standardizing issue templates, updating documentation, and refining repository settings.

Class diagram for GitHub configuration changes

classDiagram
    class Repository {
        +String homepage
        +String[] topics
        +Boolean has_issues
        +Boolean allow_rebase_merge
    }
    class Team {
        +String name
        +String permission
    }
    class Label {
        +String name
        +String color
        +String description
        +String[] aliases
    }
    Repository "1" -- "*" Team : manages
    Repository "1" -- "*" Label : uses

    note for Repository "Updated homepage URL and topics list"
    note for Team "Added new team permissions"
    note for Label "Added color attribute to labels"
Loading

File-Level Changes

Change Details Files
Enhanced contributing guidelines with clearer instructions and process improvements
  • Added link to Innersourcing Flow Guide for Alaska Airlines employees
  • Updated pull request submission guidelines with clearer consultation requirements
  • Added detailed instructions about git rebase and linear history requirements
  • Enhanced commit message format documentation with examples
  • Clarified the process for feature requests and issue submissions
.github/CONTRIBUTING.md
Updated repository settings and team configurations
  • Removed repository description
  • Updated topics list
  • Added team permissions configuration
  • Updated label configurations with new colors and descriptions
.github/settings.yml
Improved issue templates and workflow configurations
  • Added new YAML-based issue templates for features and general support
  • Updated bug report template with improved fields
  • Added new GitHub workflow for demo publishing
  • Updated test and publish workflow conditions
.github/ISSUE_TEMPLATE/bug_report.yml
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
.github/workflows/testPublish.yml
.github/workflows/publishDemo.yml
Simplified Code of Conduct with removal of specific contact information
  • Removed specific email contact information
  • Updated formatting and structure
.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

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:

  • This PR combines multiple unrelated changes (contributing docs, GitHub settings, issue templates etc). Please split into separate focused PRs for each area of change to facilitate better review and maintenance.
  • Please add context in the PR description explaining the motivation for key changes like removing the repository description from settings.yml
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.

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.

3 participants