09c9d75a63
|
||
|---|---|---|
| .. | ||
| architecture | ||
| contributing-guide | ||
| images | ||
| infrastructure | ||
| references | ||
| releases | ||
| reviewer-notes | ||
| README.md | ||
README.md
Docs
Contribution Guide
Looking to make a contribution to this repo? Check out our guide for a walk-through on how to make your first contribution:
- Getting Set up
- Building Samples and Packages
- Running a Sample or Storybook
- Testing your changes
- Writing unit tests
- Submitting a PR
- Having your changes published
Architecture
- Creating Customizable UI Components - Best practices and examples on creating delightful UI components
- Declarative Component Design
- Framework Design Principles - Core tenets our packages must build towards
- Specifying Package Dependencies - Decide where to specify package dependencies
Repo Infrastructure
- API extractor - Preventing breaking changes
- Beachball - Package version bumper and changelog generator
- Chromatic - Chromatic visual testing
- ESLint and Prettier - Code style enforcing
- GitHub Issue templates - GitHub bug and feature request templates
- Jest - Unit test framework
- Pull Request Gates and Templates - Gates blocking PRs and the PR template
- Rollup - Used to create hybrid npm package (generates commonjs bundle)
- Rush monorepo manager - Why Rush is used and useful Rush commands
References
- Package releases - Process for releasing new versions of packages developed in this repo
- Automated tests help us move fast
- Reviewer notes - Common guidelines gleaned through code reviews
- Hero sample maintenance - When and how to update hero samples
- Release change-logs - describes how we maintain change-logs for releases