AURO MIGRATION: Update Templates to v2 #33
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's Guide by SourceryThis pull request updates the templates and configurations for the Auro Design System, focusing on improving contribution guidelines, issue reporting, and workflow processes. It also updates the testing and publishing workflows to include Node.js versions 20 and 22. State diagram: Updated issue lifecyclestateDiagram-v2
[*] --> Submitted
Submitted --> UnderReview: Team reviews within 48h
UnderReview --> Approved: Team approves
UnderReview --> Closed: Team rejects
Approved --> InProgress: Work starts
InProgress --> Abandoned: No activity for 30 days
InProgress --> Completed: Work finished
Abandoned --> [*]
Completed --> [*]
Closed --> [*]
Flow diagram: Updated PR contribution processgraph TD
A[Submit Issue] -->|Wait 48h max| B[Team Review]
B --> C{Issue Approved?}
C -->|Yes| D[Start Work]
C -->|No| E[Issue Closed]
D --> F[Create Feature Branch]
F --> G[Make Changes]
G --> H[Commit with Convention]
H --> I[Rebase on Main]
I --> J[Push Changes]
J --> K[Create PR]
K --> L[Team Review]
L --> M{PR Approved?}
M -->|Yes| N[Merge to Main]
M -->|No| O[Address Feedback]
O --> L
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Surge demo deployment failed! 😭 |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @chrisfalaska - I've reviewed your changes - here's some feedback:
Overall Comments:
- The PR replaces older MD issue templates with YAML versions. Please double-check that any external documentation or integrations referencing the old .md templates are updated accordingly to avoid contributor confusion.
- In the workflows (e.g., testPublish.yml and codeql.yml), node versions and branch triggers were updated. Confirm that these new settings (node 20/22, and including beta branch) match your intended release and testing strategies.
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+65
to
+68
| $ git checkout main | ||
| $ git pull | ||
| $ git checkout [feature branch] | ||
| $ git rebase main |
There was a problem hiding this comment.
suggestion (bug_risk): Cautionary note about force pushing.
Force pushing can rewrite history and should be used with caution. It's important to understand the risks before using it.
Suggested change
| $ git checkout main | |
| $ git pull | |
| $ git checkout [feature branch] | |
| $ git rebase main | |
| $ git checkout main | |
| $ git pull | |
| $ git checkout [feature branch] | |
| $ git rebase main | |
| > **⚠️ Warning:** If you need to force push after rebasing (`git push --force`), use it with extreme caution. Force pushing rewrites the branch's history and can cause problems for other developers who have based their work on the previous branch state. Consider using `git push --force-with-lease` instead, which is safer as it prevents accidentally overwriting others' work. |
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. |
There was a problem hiding this comment.
suggestion: Consider replacing the specific email address with a more general contact method.
Using a generic contact like a dedicated email address for reporting such issues or a web form might be more maintainable in the long run.
Suggested implementation:
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening a confidential issue at https://github.com/AlaskaAirlines/[repo-name]/issues/new/choose or by emailing [email protected]. All complaints will be reviewed and investigated
Note: The specific contact method (URL and email) should be adjusted based on:
- The actual repository name in place of [repo-name]
- The preferred contact email address for your organization
- Whether you want to use a different reporting mechanism like a web form or alternative contact method
Please adjust these placeholders according to your organization's preferred reporting channels.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #30
Summary by Sourcery
Update issue templates to YAML format and add new templates for general support, stories, tasks, and groups. Update the settings YAML file and remove the old markdown templates. Update node version to 20 and 22 for testing and publishing, and update the codeql workflow to use javascript. Update the contributing guidelines with more information about submitting issues and pull requests, including a section on rebasing. Update the code of conduct and security policy. Update the pull request template and add a codeowners file. Add a new workflow to publish a demo on pull requests to the main branch.
New Features:
CI:
Documentation: