search

trendmicro-frontend / tonic-ui

Tonic UI is a UI component library for React, built with Emotion and Styled System. It is designed to be easy to use and easy to customize.
https://trendmicro-frontend.github.io/tonic-ui
MIT License
125 stars 28 forks source link

Docs: Update contributing guide #881

Closed cheton closed 2 months ago

cheton commented 2 months ago

This PR aims to update the Contributing Guide to better encourage and support contributions.

codesandbox[bot] commented 2 months ago

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders
Open Preview

codesandbox-ci[bot] commented 2 months ago

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 74.88%. Comparing base (b151a70) to head (4a3ff3e).

:exclamation: Current head 4a3ff3e differs from pull request most recent head 852c466

Please upload reports for the commit 852c466 to get more accurate results.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## v2 #881 +/- ## ========================================== + Coverage 74.83% 74.88% +0.04% ========================================== Files 375 375 Lines 6140 6140 ========================================== + Hits 4595 4598 +3 + Misses 1545 1542 -3 ``` | [Flag](https://app.codecov.io/gh/trendmicro-frontend/tonic-ui/pull/881/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trendmicro-frontend) | Coverage Δ | | |---|---|---| | [codemod](https://app.codecov.io/gh/trendmicro-frontend/tonic-ui/pull/881/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trendmicro-frontend) | `74.28% <ø> (ø)` | | | [react](https://app.codecov.io/gh/trendmicro-frontend/tonic-ui/pull/881/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trendmicro-frontend) | `72.49% <ø> (+0.05%)` | :arrow_up: | | [react-base](https://app.codecov.io/gh/trendmicro-frontend/tonic-ui/pull/881/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trendmicro-frontend) | `100.00% <ø> (ø)` | | | [react-hooks](https://app.codecov.io/gh/trendmicro-frontend/tonic-ui/pull/881/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trendmicro-frontend) | `87.59% <ø> (ø)` | | | [styled-system](https://app.codecov.io/gh/trendmicro-frontend/tonic-ui/pull/881/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trendmicro-frontend) | `93.42% <ø> (ø)` | | | [theme](https://app.codecov.io/gh/trendmicro-frontend/tonic-ui/pull/881/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trendmicro-frontend) | `100.00% <ø> (ø)` | | | [utils](https://app.codecov.io/gh/trendmicro-frontend/tonic-ui/pull/881/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trendmicro-frontend) | `89.14% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trendmicro-frontend#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

trendmicro-frontend-bot commented 2 months ago

Tonic UI Demo

cheton commented 2 months ago

@CodiumAI-Agent /review

CodiumAI-Agent commented 2 months ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5] 3
🧪 Relevant tests No
🔒 Security concerns No
⚡ Key issues to review Possible Bug:
The query selector in 'TableOfContents.js' uses '&>h2,&>h3,&>h4,&>h5,&>h6' which might be intended as '>h2, >h3, >h4, >h5, >h6'. The '&' character does not have a special meaning in CSS selectors in this context and might cause the query to fail.
Code Consistency:
In 'BorderedBox.js', the 'border' property is set with a numeric value which might be intended to be a string specifying the width and style (e.g., '1px solid'). This could lead to unexpected behavior if not handled properly in the 'Box' component.