PD-453: Update Contributing Documentation #197

bruugey · 2019-11-18T16:35:36Z

✍️ Proposed changes

In an effort to make contributing to LeafyGreen as seamless as possible, I've updated our contributing guidelines. (Thank you for all of the feedback @matt-d-rat 👋)

Upgrade our contributing documentation. New sections:

Can I contribute?
Roadmap
Getting Started (Typescript, Emotion, React Design Patterns)

Please let me know if I missed anything, or if there's anything else worth mentioning here! Thank you!

🎟 Jira ticket: PD-453

🛠 Types of changes

Tooling

✅ Checklist

I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)
I have run yarn changeset and documented my changes

bruugey · 2019-11-18T16:36:27Z

Also, once my scaffold-script PR gets merged, I will reference that here!

hswolff · 2019-11-18T20:26:53Z

CONTRIBUTING.md

Suggested change

LeafyGreen uses Typescript, to help make consumption of this library as intuitive and error-free as possible. If you're new to Typescript, these resources may be able to help you get started:

LeafyGreen uses TypeScript, to help make consumption of this library as intuitive and error-free as possible. If you're new to TypeScript, these resources may be able to help you get started:

hswolff · 2019-11-18T20:27:29Z

CONTRIBUTING.md

Suggested change

1. [Typescript Handbook](https://www.typescriptlang.org/docs/handbook/basic-types.html)

1. [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/basic-types.html)

hswolff · 2019-11-18T20:27:36Z

CONTRIBUTING.md

Suggested change

2. [Typescript Cheatsheet](https://github.com/typescript-cheatsheets/react-typescript-cheatsheet)

2. [TypeScript Cheatsheet](https://github.com/typescript-cheatsheets/react-typescript-cheatsheet)

hswolff · 2019-11-18T20:28:06Z

CONTRIBUTING.md

plus also note:

you must use our wrapper

because of constraints over how styles are injected into the page

hswolff · 2019-11-18T20:28:22Z

CONTRIBUTING.md

Suggested change

`import {css, cx} from @leafygreen-ui/emotion`

`import { css, cx } from @leafygreen-ui/emotion`

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…e to leafygreen-ui (#3165) * LG-4333: VerticalStepper (#163) * wip * wip, transitions * image * break out step icon component * tabindex * line color * fix story * status to state * padding * style cleanup * style updates * consts * add tests * README * changeset * types and tests * cleanup * cleanup * lint * cleanup again * some feedback * update icon styles * inert and tabindex * use descedants * remove extra div * update package.json * pass isCompleted to StepIcon * cleanup * feedback * Version Packages (#169) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Fix naming of lg-private packages (#183) * Fix lg-private packages naming * Changeset * LG-4395: feature walls major release (#186) * LG-4395: vertical stepper design QA * LG-4395: feature walls design QA * Changeset * Version Packages (#184) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Use actions slot prop for vertical stepper and activation steps (#191) * VerticalStepper takes actions prop instead of primaryButtonProps and secondaryButtonProps * ActivationSteps uses updated VerticalStepper API * Changeset * Address feedback * Version Packages (#190) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * LG-4412: all sections render in card UI (#194) * Update Section styling and add optional renderInCard prop * FeatureOverview renders in card, handles children container, and removes custom storybook decorator * Templates always renders in card and export type Template * UseCases always renders in card * ActivationSteps type updates and remove storybook decorator * Export types for ActivationStep, Template, and UseCase * Changeset * LG-4413: vertical stepper always renders description and media (#195) * VerticalStepper always renders description and media * Changeset * Cleanup * Version Packages (#197) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * LG-4670: feature walls component resizing (#294) * Update vertical stepper button layout on smaller breakpoints * Fix resizing in AccordionPanel * Fix resizing in ExpandableGrid * Feedback * height is always available * Version Packages (#292) * Version Packages * Version next @lg-private/vertical-stepper and update changelogs --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Stephen Lee <[email protected]> * Updates Popover/Menu/Tooltip to TopLayer LG-4746 (#337) * bump other packages * major popover updates * bump provider * bump global provider * bump cli * rm popoverZIndex * Create forty-days-rest.md * Delete .eslintignore * update lg to latest major * Removes prop-types, and bump LG packages * lint * Update .eslintrc.js * update storybook @lg-tools/storybook-utils * lint * Version Packages (#343) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * PNPM + Storybook 8 (private) (#426) * pnpm import * Delete yarn.lock * workflows * yarn -> pnpm docs * workspace:^ * add missing global packages * @storybook/test * story ts fixes * Adds missing peers * rm lg.json * bump base lg * fix product icon builds * fix sb * bump peer deps * rm pnpm/action-setup@v4 * Revert "rm pnpm/action-setup@v4" This reverts commit 14198eb258e958ddaa0e480fee17cfddec5ce6fd. * Update pnpm-lock.yaml * apk * apk all * wget * restore pnpm * specific pnpm action * workspace * lint fix * tools @ latest * minor lint errors * tools build dev deps * typescript * tsconfig * package exports * ts fixes * Create rollup.config.mjs * lint * checkout main src * ts fixes * lint * isolated async tests * Update CloudNav.analytics.spec.tsx * skip mongonav tests * feature walls tests * Create rollup.config.mjs * lint fix * Update pr.yml * Update release.yml * cache/restore * chromatic + pnpm * update cache restore paths * cache save path * addon 0.5.2-next.0 * addon 0.5.2-next.2 * chore(vertical-stepper): move from @lg-private to @leafygreen-ui scope * chore(vertical-stepper): disable snapshot of LiveExample story --------- Co-authored-by: Shaneeza <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Adam Thompson <[email protected]>

bruugey requested review from DesignerDave, hswolff and matt-d-rat November 18, 2019 16:36

bruugey added the 4. Tooling ⚒️ updates to workspace config or internal tooling label Nov 18, 2019

hswolff requested changes Nov 18, 2019

View reviewed changes

bruugey added 2 commits November 18, 2019 16:27

upgrade contributing documentation

4bdfe5a

responding to PR feedback

e7a6381

bruugey force-pushed the contributing.md branch from c98a3bc to e7a6381 Compare November 18, 2019 21:28

bruugey requested a review from hswolff November 18, 2019 21:29

hswolff approved these changes Nov 18, 2019

View reviewed changes

bruugey changed the title ~~PD-453: Upgrade contributing documentation~~ PD-453: Update contributing documentation Nov 18, 2019

bruugey changed the title ~~PD-453: Update contributing documentation~~ PD-453: Update Contributing Documentation Nov 18, 2019

added two more favors

07b4897

DesignerDave approved these changes Nov 19, 2019

View reviewed changes

Merge branch 'master' into contributing.md

1888b5e

bruugey removed the request for review from matt-d-rat November 19, 2019 20:14

bruugey merged commit 3606313 into master Nov 19, 2019

bruugey deleted the contributing.md branch November 19, 2019 20:17

bruugey added a commit that referenced this pull request Aug 9, 2023

PD-453: Update Contributing Documentation (#197)

cf1f8a9

stephl3 pushed a commit that referenced this pull request Sep 29, 2025

Version Packages (#197)

347c44a

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

PD-453: Update Contributing Documentation #197

PD-453: Update Contributing Documentation #197

Uh oh!

bruugey commented Nov 18, 2019

Uh oh!

bruugey commented Nov 18, 2019

Uh oh!

hswolff Nov 18, 2019

Uh oh!

bruugey Nov 18, 2019

Uh oh!

hswolff Nov 18, 2019

Uh oh!

bruugey Nov 18, 2019

Uh oh!

hswolff Nov 18, 2019

Uh oh!

bruugey Nov 18, 2019

Uh oh!

hswolff Nov 18, 2019

Uh oh!

bruugey Nov 18, 2019

Uh oh!

hswolff Nov 18, 2019

Uh oh!

bruugey Nov 18, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	LeafyGreen uses Typescript, to help make consumption of this library as intuitive and error-free as possible. If you're new to Typescript, these resources may be able to help you get started:
	LeafyGreen uses TypeScript, to help make consumption of this library as intuitive and error-free as possible. If you're new to TypeScript, these resources may be able to help you get started:

	1. [Typescript Handbook](https://www.typescriptlang.org/docs/handbook/basic-types.html)
	1. [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/basic-types.html)

	2. [Typescript Cheatsheet](https://github.com/typescript-cheatsheets/react-typescript-cheatsheet)
	2. [TypeScript Cheatsheet](https://github.com/typescript-cheatsheets/react-typescript-cheatsheet)

	`import {css, cx} from @leafygreen-ui/emotion`
	`import { css, cx } from @leafygreen-ui/emotion`

PD-453: Update Contributing Documentation #197

PD-453: Update Contributing Documentation #197

Uh oh!

Conversation

bruugey commented Nov 18, 2019

✍️ Proposed changes

🛠 Types of changes

✅ Checklist

Uh oh!

bruugey commented Nov 18, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants