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

[PM-16998] Provide code style for Swift #517

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

KatherineInCode
Copy link
Contributor

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-16998

📔 Objective

This attempts to codify some of the code style conventions in the iOS codebase, and provides a place for us to document further decisions about code style.

⏰ 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

@KatherineInCode KatherineInCode requested a review from a team as a code owner January 13, 2025 19:03
Copy link

cloudflare-workers-and-pages bot commented Jan 13, 2025

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0b03126
Status: ✅  Deploy successful!
Preview URL: https://1653bd54.contributing-docs.pages.dev
Branch Preview URL: https://pm-16998-swift-style.contributing-docs.pages.dev

View logs

@KatherineInCode KatherineInCode requested a review from a team January 13, 2025 19:03
Copy link

github-actions bot commented Jan 13, 2025

Logo
Checkmarx One – Scan Summary & Detailsc39337e2-98dc-42f6-8f5e-39becd7c6e69

Great job, no security vulnerabilities found in this Pull Request

Copy link
Member

@fedemkr fedemkr left a comment

Choose a reason for hiding this comment

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

Great job, really like this!
🤔 I was wondering if we should also put handful Xcode settings for Text Editing here as well as a tip. E.g. Enabling "Show reformatting guide" in "Editing" tab or in the same tab "Automatically trim trailing whitespace" + "Including whitespace-only lines".

@KatherineInCode
Copy link
Contributor Author

Xcode settings

Good call! Theoretically we could also put the defaults write commands for them 🤔 but I'll update it to include those

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