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

feat(Breadcrumbs): use ol instead of ul #7007

Merged

Conversation

bvandercar-vt
Copy link
Contributor

Breadcrumbs are ordered so they should be tagged as such.

Here is the aria example: https://www.w3.org/WAI/ARIA/apg/patterns/breadcrumb/examples/breadcrumb/

It uses ol.

@changelog-app
Copy link

changelog-app bot commented Oct 3, 2024

Generate changelog in packages/core/changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

feat(Breadcrumbs): use ol instead of ul

Check the box to generate changelog(s)

  • Generate changelog entry

Copy link
Contributor

@ggdouglas ggdouglas left a comment

Choose a reason for hiding this comment

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

I fundamentally agree with this change. However, I want to explicitly highlight that it could potentially break consumers of this component who style directly using the ul element tag. While this scenario should be uncommon, I believe internal elements should not be considered a breaking API change. Nonetheless, we will make an explicit note of the change in the changelog upon release.

@ggdouglas ggdouglas merged commit 73502b1 into palantir:develop Oct 8, 2024
12 of 14 checks passed
@bvandercar-vt
Copy link
Contributor Author

I fundamentally agree with this change. However, I want to explicitly highlight that it could potentially break consumers of this component who style directly using the ul element tag. While this scenario should be uncommon, I believe internal elements should not be considered a breaking API change. Nonetheless, we will make an explicit note of the change in the changelog upon release.

Well said, I did consider that with this change!

@bvandercar-vt bvandercar-vt deleted the bvandercar/breadctrumbs-ol branch November 7, 2024 19:51
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