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

Rework the internal contributing and conventions doc #3818

Closed
benelan opened this issue Dec 30, 2021 · 3 comments
Closed

Rework the internal contributing and conventions doc #3818

benelan opened this issue Dec 30, 2021 · 3 comments
Assignees
Labels
1 - assigned Issues that are assigned to a sprint and a team member. Calcite (dev) Issues logged by Calcite developers. discussion Issues relating to a conversation where feedback is optional. docs Issues relating to documentation updates only. p - low Issue is non core or affecting less that 10% of people using the library

Comments

@benelan
Copy link
Member

benelan commented Dec 30, 2021

Description

The goal is to get the internal doc looking like Hub's

  1. I am going to break the conventions into different files by topic so that they can be items in the storybook sidebar like above.

    • Testing
    • Documentation
    • A11y
    • i18n
    • Style
    • Maybe more?
  2. I will audit the existing conventions and remove any that are no longer valid.

  3. Then start beefing up the conventions with unspoken stuff we all just do. If you all think of anything specific that needs to be added to the conventions comment on this issue or edit the description below.

Which Component

NA

Resources

Specific conventions that need to be added (feel free to add more here)

cc @driskull @jcfranco @macandcheese


TODO

  • Internal patterns
    • form-associated components
    • labelable components
    • conditionally-slotted rendering components
    • internal event handling
    • distinguishing between internal and external prop setting
    • global attribute utils
    • observer creation (mutation, intersection, resize)
  • Testing
    • E2E vs spec
    • common test helpers
  • Naming
    • event variable name (e: event vs event: event)
@benelan benelan added discussion Issues relating to a conversation where feedback is optional. docs Issues relating to documentation updates only. 1 - assigned Issues that are assigned to a sprint and a team member. labels Dec 30, 2021
@benelan benelan self-assigned this Dec 30, 2021
@jcfranco
Copy link
Member

jcfranco commented Jan 19, 2022

Jotting some ideas:

  • Internal patterns
    • form-associated components
    • labelable components
    • conditionally-slotted rendering components
    • internal event handling
    • distinguishing between internal and external prop setting
    • global attribute utils
    • observer creation (mutation, intersection, resize)
  • Testing
    • E2E vs spec
    • common test helpers

benelan added a commit that referenced this issue Sep 2, 2022
…5228)

**Related Issue:** #3818

## Summary
- Added additional information to the contributing and documentation convention.
- Fixed outdated info
<!--

Please make sure the PR title and/or commit message adheres to the https://www.conventionalcommits.org/en/v1.0.0/ specification.

Note: If your PR only has one commit and it is NOT semantic, you will need to either

a. add another commit and wait for the check to update
b. proceed to squash merge, but make sure the commit message is the same as the title.

This is because of the way GitHub handles single-commit squash merges (see zeke/semantic-pull-requests#17)

If this is component-related, please verify that:

- [ ] feature or fix has a corresponding test
- [ ] changes have been tested with demo page in Edge

---

If this is skipping an unstable test:

- include info about the test failure
- submit an unstable-test issue by [choosing](https://github.com/Esri/calcite-components/issues/new/choose) the unstable test template and filling it out

-->
@benelan benelan added the Calcite (dev) Issues logged by Calcite developers. label Jan 30, 2023
@geospatialem geospatialem self-assigned this Oct 27, 2023
@geospatialem
Copy link
Member

Related: #7724 - could explore a new patterns documentation page which includes #3818 (comment) and open/close to better serve users.

@jcfranco
Copy link
Member

Confirmed w/ @benelan. This is no longer as we've started moving internal doc to our wiki. Closing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - assigned Issues that are assigned to a sprint and a team member. Calcite (dev) Issues logged by Calcite developers. discussion Issues relating to a conversation where feedback is optional. docs Issues relating to documentation updates only. p - low Issue is non core or affecting less that 10% of people using the library
Projects
None yet
Development

No branches or pull requests

4 participants