github-starred/android
2
0
Fork 0
mirror of https://github.com/bitwarden/android.git synced 2026-05-06 07:48:22 -05:00
Code Issues 1.1k Packages Projects Releases 122 Wiki Activity

[PR #6256] [MERGED] Update STYLE_AND_BEST_PRACTICES.md to clarify KDoc requirements and fix whitespace #19190

New Issue
Closed
opened 2026-04-15 03:41:43 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-15 03:41:43 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/bitwarden/android/pull/6256
Author: @SaintPatrck
Created: 12/11/2025
Status: ✅ Merged
Merged: 12/11/2025
Merged by: @SaintPatrck

Base: main ← Head: docs/update-style-and-best-practices

📝 Commits (1)

  • 0f6086b Update STYLE_AND_BEST_PRACTICES.md to clarify KDoc requirements and fix whitespace

📊 Changes

1 file changed (+6 additions, -6 deletions)

View changed files

📝 docs/STYLE_AND_BEST_PRACTICES.md (+6 -6)

📄 Description

🎟️ Tracking

N/A

📔 Objective

Refine the documentation guidelines regarding KDoc requirements for specific class members and remove trailing whitespace throughout the file.

  • Update the "Documentation" section to explicitly state that companion objects, alongside private classes, functions, and properties, may optionally be documented as needed.
  • Remove trailing whitespace in several code blocks within the "Dependency Injection" and "Exception Handling" sections to ensure consistent formatting.

⏰ 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

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/bitwarden/android/pull/6256 **Author:** [@SaintPatrck](https://github.com/SaintPatrck) **Created:** 12/11/2025 **Status:** ✅ Merged **Merged:** 12/11/2025 **Merged by:** [@SaintPatrck](https://github.com/SaintPatrck) **Base:** `main` ← **Head:** `docs/update-style-and-best-practices` --- ### 📝 Commits (1) - [`0f6086b`](https://github.com/bitwarden/android/commit/0f6086bb2fadcb3d5d696da2a308a351a7ce9570) Update STYLE_AND_BEST_PRACTICES.md to clarify KDoc requirements and fix whitespace ### 📊 Changes **1 file changed** (+6 additions, -6 deletions) <details> <summary>View changed files</summary> 📝 `docs/STYLE_AND_BEST_PRACTICES.md` (+6 -6) </details> ### 📄 Description ## 🎟️ Tracking N/A ## 📔 Objective Refine the documentation guidelines regarding KDoc requirements for specific class members and remove trailing whitespace throughout the file. - Update the "Documentation" section to explicitly state that companion objects, alongside private classes, functions, and properties, may optionally be documented as needed. - Remove trailing whitespace in several code blocks within the "Dependency Injection" and "Exception Handling" sections to ensure consistent formatting. ## ⏰ 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 <!-- Suggested interactions but feel free to use (or not) as you desire! --> - 👍 (`:+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 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-15 03:41:43 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
app:authenticator
app:password-manager
bug
bug-passkey
customer-support
duplicate
enhancement
good first issue
help wanted
needs-reply
needs-response
pull-request
Mirrored from GitHub Pull Request
 question
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/android#19190
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?