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.

Sign up for GitHub

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

Jump to bottom

docs: add convention for property values #9185

Merged
merged 3 commits into from
Apr 26, 2024
Merged

docs: add convention for property values #9185

merged 3 commits into from
Apr 26, 2024

Conversation

driskull
Copy link
Member

Related Issue: N/A

Summary

add convention for property values

@github-actions github-actions bot added the chore Issues with changes that don't modify src or test files. label Apr 24, 2024
@driskull driskull marked this pull request as ready for review April 25, 2024 22:47
@driskull driskull requested a review from a team as a code owner April 25, 2024 22:47
macandcheese
macandcheese approved these changes Apr 25, 2024
View reviewed changes
Copy link
Contributor

@macandcheese macandcheese left a comment

Choose a reason for hiding this comment

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

🏅

geospatialem
geospatialem approved these changes Apr 25, 2024
View reviewed changes
Copy link
Member

@geospatialem geospatialem left a comment

Choose a reason for hiding this comment

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

Awesome! 💪🏻

nitpick WRT conventional commit:
Would this be a doc rather than chore?

packages/calcite-components/conventions/README.md Show resolved Hide resolved
@driskull
Copy link
Member Author

Would this be a doc rather than chore?

It's not really documentation of any API and its not useful for an end user to see. 🤔 Not sure if there's a better conventional commit type.

@driskull driskull added the skip visual snapshots Pull requests that do not need visual regression testing. label Apr 25, 2024
@driskull
Copy link
Member Author

Looks like we don't show docs conventional commits in the changelog so I could use that commit type. Its documentation for us but not the end user so I'm not sure if docs or chore makes more sense. @jcfranco?

@jcfranco
Copy link
Member

jcfranco commented Apr 25, 2024 •
edited

Regarding the type, I could see us using either since we we don't include entries for docs in the changelog. We could

  1. use docs to refer to both internal/external doc or
  2. keep docs for public and chore(docs) (or something similar) for internal doc

No strong preference, but 1 might make it simpler. Whatever we decide, we should include it in #9116.

Here are some examples of what we've used for these types of updates.

jcfranco
jcfranco approved these changes Apr 25, 2024
View reviewed changes
Copy link
Member

@jcfranco jcfranco left a comment

Choose a reason for hiding this comment

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

✨🏆✨

@geospatialem
Copy link
Member

Regarding the type, I could see us using either since we we don't include entries for docs in the changelog. We could

  1. use docs to refer to both internal/external doc or
  2. keep docs for public and chore(docs) (or something similar) for internal doc

No strong preference, but 1 might make it simpler. Whatever we decide, we should include it in #9116.

Here are some examples of what we've used for these types of updates.

Thanks for laying out some options for us, and for referencing the related issue, @jcfranco! 🙌🏻

Personally I lean towards docs since it seems more intuitive that we're updating docs, whether it be for internal or external uses. But am flexible if other folks think we should differentiate between the two and opt for docs for external, and chore(docs) for internal uses. What do others think?

@driskull driskull changed the title chore: add convention for property values docs: add convention for property values Apr 26, 2024
@driskull
Copy link
Member Author

I'll change to docs.

@driskull driskull merged commit 45d5294 into main Apr 26, 2024
15 checks passed
@driskull driskull deleted the dris0000/property-values-convention branch April 26, 2024 16:23
@github-actions github-actions bot added this to the 2024-04-30 - Apr Release milestone Apr 26, 2024
benelan added a commit that referenced this pull request Apr 27, 2024
@benelan
Merge remote-tracking branch 'origin/main' into benelan/constraint-va…
18b2e30 
…lidation-apis

* origin/main: (26 commits)
  chore: release next
  fix: fix memory leak affecting components using conditionally-rendered slots (#9208)
  test(segmented-control): enable form validation tests (#9206)
  build(deps): update storybook monorepo to v8.0.9 (#9198)
  build(deps): update dependency rollup to v4.16.4 (#9190)
  build(deps): update dependency @stencil/core to v4.17.1 (#9199)
  build(deps): update typescript-eslint monorepo to v7.7.1 (#9201)
  build(deps): update amannn/action-semantic-pull-request action to v5.5.2 (#9189)
  build(deps): update dependency type-fest to v4.16.0 (#9200)
  chore: release next
  feat: ensure all components inherit font-family (#8388)
  chore: release next
  fix(slider): fix fill placement and tick styling when ranged (#9204)
  fix(combobox): update the focused chevron icon color (#9202)
  docs: add convention for property values (#9185)
  chore: restore Stencil build step prior `screenshot-tests:preview` (#9180)
  chore: release next
  fix(tree-item): do not select when chevron clicked (#9115)
  chore: release next
  fix(slider): style ticks according to the fill placement (#9196)
  ...
benelan added a commit that referenced this pull request Apr 27, 2024
@benelan
Merge remote-tracking branch 'origin/main' into benelan/add-invalid-c…
008b7c4 
…ustom-event

* origin/main: (24 commits)
  chore: release next
  fix: fix memory leak affecting components using conditionally-rendered slots (#9208)
  test(segmented-control): enable form validation tests (#9206)
  build(deps): update storybook monorepo to v8.0.9 (#9198)
  build(deps): update dependency rollup to v4.16.4 (#9190)
  build(deps): update dependency @stencil/core to v4.17.1 (#9199)
  build(deps): update typescript-eslint monorepo to v7.7.1 (#9201)
  build(deps): update amannn/action-semantic-pull-request action to v5.5.2 (#9189)
  build(deps): update dependency type-fest to v4.16.0 (#9200)
  chore: release next
  feat: ensure all components inherit font-family (#8388)
  chore: release next
  fix(slider): fix fill placement and tick styling when ranged (#9204)
  fix(combobox): update the focused chevron icon color (#9202)
  docs: add convention for property values (#9185)
  chore: restore Stencil build step prior `screenshot-tests:preview` (#9180)
  chore: release next
  fix(tree-item): do not select when chevron clicked (#9115)
  chore: release next
  fix(slider): style ticks according to the fill placement (#9196)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jcfranco jcfranco jcfranco approved these changes

@macandcheese macandcheese macandcheese approved these changes

@geospatialem geospatialem geospatialem approved these changes

Assignees

@driskull driskull

Labels
chore Issues with changes that don't modify src or test files. skip visual snapshots Pull requests that do not need visual regression testing.
Projects
None yet
Milestone
2024-04-30 - Apr Release
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@driskull @jcfranco @geospatialem @macandcheese