Skip to content

Create contributing-docs/debt.md #2071

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

Closed
wants to merge 2 commits into from
Closed

Create contributing-docs/debt.md #2071

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0eeba5
Create debt.md
siddharthkp May 12, 2022
f8d7389
Update debt.md
siddharthkp May 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions contributor-docs/debt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### Technical debt

This is where catalog technical debt, reasons we took it on and strategies on paying it in the future.

1. TODO: [create-slots](https://github.com/primer/react/blob/main/src/utils/create-slots.tsx) needs a double render which would create UI jank with server side rendering
2. TODO: styled-components + styled-system performance adds up over time as components build up
3. TODO: primitives are resolved to hex values instead of css variables which creates [flash of incorrect theme](https://github.com/primer/react/pull/1868#:~:text=Long%20term%20fix%20(not%20in%20this%20PR)%3A)