Skip to content

Add documentation to public members #205

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

Merged
merged 9 commits into from
Apr 18, 2025
Merged

Add documentation to public members #205

merged 9 commits into from
Apr 18, 2025

Conversation

Hinton
Copy link
Member

@Hinton Hinton commented Mar 29, 2025

🎟️ Tracking

📔 Objective

Adds documentation to a bunch of areas that are currently lacking docs.

⏰ 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

@Hinton Hinton changed the title Document bitwarden-cli Add documentation to all public items Mar 29, 2025
Copy link
Contributor

github-actions bot commented Mar 29, 2025

Logo
Checkmarx One – Scan Summary & Details8d7d203c-ca2f-4fbe-929f-2ac7d0d4b918

Great job, no security vulnerabilities found in this Pull Request

Copy link

codecov bot commented Mar 29, 2025

Codecov Report

Attention: Patch coverage is 42.85714% with 8 lines in your changes missing coverage. Please review.

Project coverage is 67.19%. Comparing base (b99e954) to head (e25ebe4).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
crates/bitwarden-core/src/secrets_manager/state.rs 0.00% 5 Missing ⚠️
crates/bitwarden-core/src/mobile/crypto.rs 71.42% 2 Missing ⚠️
crates/bitwarden-core/src/util.rs 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #205      +/-   ##
==========================================
- Coverage   67.20%   67.19%   -0.02%     
==========================================
  Files         210      210              
  Lines       15952    15955       +3     
==========================================
  Hits        10721    10721              
- Misses       5231     5234       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Hinton Hinton changed the title Add documentation to all public items Add documentation to public members Apr 17, 2025
@Hinton Hinton requested a review from dani-garcia April 17, 2025 12:00
@Hinton Hinton marked this pull request as ready for review April 17, 2025 12:00
@Hinton Hinton requested a review from a team as a code owner April 17, 2025 12:00
@Hinton Hinton requested a review from dani-garcia April 17, 2025 13:49
@Hinton Hinton merged commit 2bbba2f into main Apr 18, 2025
40 of 41 checks passed
@Hinton Hinton deleted the document branch April 18, 2025 07:24
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