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

Add code style guide for Angular & TypeScript import statements #556

Merged
merged 2 commits into from
Mar 11, 2025

Conversation

Thomas-Avery
Copy link
Contributor

🎟️ Tracking

📔 Objective

There has previously been some confusion for import statements. It would be helpful to have recommendations in the style guide. Open to any recommendations or suggestions.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@Thomas-Avery Thomas-Avery requested a review from a team as a code owner March 7, 2025 20:27
Copy link

github-actions bot commented Mar 7, 2025

Logo
Checkmarx One – Scan Summary & Details3195c275-f514-43e3-bfef-d9c6fc0621d3

New Issues (1)

Checkmarx found the following issues in this Pull Request

Severity Issue Source File / Package Checkmarx Insight
MEDIUM CVE-2024-53382 Npm-prismjs-1.29.0 Vulnerable Package

Copy link
Member

@eliykat eliykat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just one minor suggestion around headings.

Copy link
Member

@MGibson1 MGibson1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, I agree with @eliykat's suggestion

Copy link

cloudflare-workers-and-pages bot commented Mar 10, 2025

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: bf6405c
Status: ✅  Deploy successful!
Preview URL: https://8672d138.contributing-docs.pages.dev
Branch Preview URL: https://add-angular-import-style.contributing-docs.pages.dev

View logs

@Thomas-Avery Thomas-Avery requested a review from eliykat March 10, 2025 16:26
@Thomas-Avery Thomas-Avery requested a review from MGibson1 March 11, 2025 14:24
@Thomas-Avery Thomas-Avery merged commit 7ee56e9 into main Mar 11, 2025
9 checks passed
@Thomas-Avery Thomas-Avery deleted the add-angular-import-style branch March 11, 2025 22:42
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