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 opt out docs link to the bws changelog #1142

Merged
merged 1 commit into from
Oct 17, 2024

Conversation

coltonhurst
Copy link
Member

📔 Objective

As discussed in PR #1122, add a link to our docs about the opt out change.

⏰ 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

@coltonhurst coltonhurst self-assigned this Oct 16, 2024
@coltonhurst coltonhurst requested a review from a team as a code owner October 16, 2024 15:09
Copy link
Contributor

Logo
Checkmarx One – Scan Summary & Details533cdf65-6a8d-4797-b9fc-155376069a1a

No New Or Fixed Issues Found

Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.17%. Comparing base (8aea2e9) to head (72b343f).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1142   +/-   ##
=======================================
  Coverage   58.17%   58.17%           
=======================================
  Files         197      197           
  Lines       13587    13587           
=======================================
  Hits         7904     7904           
  Misses       5683     5683           

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

Copy link
Member

@dani-garcia dani-garcia left a comment

Choose a reason for hiding this comment

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

Changes here LGTM.

I think it would be nice to also include a short mention of what state is used for in the docs, though. At the moment we don't explain it's use so it's hard to decide if you want to opt out or not.

@coltonhurst
Copy link
Member Author

Changes here LGTM.

I think it would be nice to also include a short mention of what state is used for in the docs, though. At the moment we don't explain it's use so it's hard to decide if you want to opt out or not.

Thanks! Great suggestion. I've submitted a request to the docs team.

@coltonhurst coltonhurst merged commit f9757b1 into main Oct 17, 2024
97 of 99 checks passed
@coltonhurst coltonhurst deleted the AddOptOutLinkToChangelog branch October 17, 2024 16:04
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