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

chore: update .gitignore and remove demo files from cache and sync gi… #88

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

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Dec 20, 2024

…thub workflow files

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Resolves: # (issue, if applicable)

Summary:

Please summarize the scope of the changes you have submitted, what the intent of the work is and anything that describes the before/after state of the project.

Type of change:

Please delete options that are not relevant.

  • New capability
  • Revision of an existing capability
  • Infrastructure change (automation, etc.)
  • Other (please elaborate)

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Update contribution guidelines, add issue templates, and configure repository settings. Update the test and publish workflow to use the main branch and update node version.

Documentation:

  • Update the contributing guidelines with more information about submitting issues and pull requests, including conventional commits, rebase on main, and pull request service level agreement.
  • Add issue templates for bug reports, feature requests, and general support.
  • Update the pull request template to remove the 'Other' option in the type of change section.

Copy link

sourcery-ai bot commented Dec 20, 2024

Reviewer's Guide by Sourcery

This PR updates the contributing guidelines, sets up team access, and removes demo files.

Sequence diagram for updated PR review process

sequenceDiagram
    actor Contributor
    participant Issue
    participant PR
    participant Maintainer

    Contributor->>Issue: Submit issue
    Note over Issue: Wait up to 48h for response
    Maintainer->>Issue: Review and discuss
    Contributor->>PR: Submit PR with conventional commits
    Note over PR: If solicited work: 24h response
    Note over PR: If unsolicited work: up to 72h response
    Maintainer->>PR: Review PR
    alt PR Approved
        Maintainer->>PR: Merge to main
    else PR Needs Changes
        Maintainer->>PR: Request changes
        Contributor->>PR: Update PR
    end
Loading

File-Level Changes

Change Details Files
Updated contributing guidelines to reflect current process.
  • Added a link to the Issues, pull requests and labels process document.
  • Clarified feature request process.
  • Added a section on submitting issues.
  • Updated bug reporting guidelines.
  • Clarified pull request submission process.
  • Added a section on feature branch naming.
  • Added a section on rebasing.
  • Updated conventional commits section.
  • Added a section on Git commit messages.
  • Updated pull request service level agreement.
.github/CONTRIBUTING.md
Set up team access in settings.yml.
  • Granted admin permission to auro-team.
  • Granted push permission to nonauroteamwriteaccess.
.github/settings.yml
Removed demo files and updated related files.
  • Added demo files to .gitignore.
  • Added publishDemo.yml workflow.
  • Added CODEOWNERS file.
  • Removed demo files.
.gitignore
.github/workflows/publishDemo.yml
.github/CODEOWNERS
demo/api.md
demo/api.min.js
demo/index.md
demo/index.min.js
Updated other Github files.
  • Updated Code of Conduct.
  • Updated testPublish.yml workflow.
  • Updated stale.yml configuration.
  • Updated pull request template.
  • Updated codeql.yml workflow.
.github/CODE_OF_CONDUCT.md
.github/workflows/testPublish.yml
.github/stale.yml
.github/PULL_REQUEST_TEMPLATE.md
.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

github-actions bot commented Dec 20, 2024

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

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