Conversation
akademy
left a comment
akademy
left a comment
There was a problem hiding this comment.
Sorry, did a re-review on the contributing.md file.
Mostly, everything is fine.....
| labels: ["type:rfc", "status:needs-triage"] | ||
| --- | ||
|
|
||
| # RFC: [Title] |
There was a problem hiding this comment.
I don't know what rfc means... maybe we could just put the full name here?
| @@ -1,131 +1,134 @@ | |||
| SciReactUI Changelog | |||
| ==================== | |||
There was a problem hiding this comment.
Do we have to lose this formatting? It is far clearer this way.
| - An *auth* parameter was added to *User* to simplify when *AuthProvider* is used. | ||
| - *ScrollableImages* can now display in a wide view, with multiple images. | ||
|
|
||
| - New _Progress_ component based on Diamond Light added. |
There was a problem hiding this comment.
Why Progress and not Progress?!
|
|
||
| ## Project Principles | ||
|
|
||
| - **Quality over quantity**: stable, well‑tested, well‑documented components. |
There was a problem hiding this comment.
I don't think we have well-documented components in most cases.
| Not in scope: | ||
|
|
||
| - Application‑specific business logic. | ||
| - Utilities unrelated to UI components. |
There was a problem hiding this comment.
Actually, I already stuck in a auth component... which while it does interact with UI bits, it doesn't itself provide ui... and it is technically business logic, even if it is generic.
| - Understand every line submitted. | ||
| - No unverifiable AI‑generated content. | ||
| - Validate types, accessibility, and performance. | ||
| - Never include secrets or internal prompts. | ||
| - No emojis. |
There was a problem hiding this comment.
This section is a weird collection of things. Most already covered. And what is with emojis?!
| - Understand every line submitted. | |
| - No unverifiable AI‑generated content. | |
| - Validate types, accessibility, and performance. | |
| - Never include secrets or internal prompts. | |
| - No emojis. | |
| - Understand every line submitted. | |
| - No unverifiable AI‑generated content. | |
| - Never include prompts. |
| ### Visual Regression Testing | ||
|
|
||
| Automated comparison detecting unintended visual changes between versions. |
There was a problem hiding this comment.
This is never used in the document... I bet half of the rest of this section isn't either....
| Examples: | ||
|
|
||
| - New interactive components (Select, Tabs, Dialog, DatePicker…) | ||
| - New primitives (tokens, foundational elements) | ||
| - Multi‑part components with complex behaviour |
There was a problem hiding this comment.
Is it really necessary to explain what a component is!
| 1. **Open an _RFC_ issue.** | ||
| Must include: problem, use‑cases, [API design](#api-design), [accessibility model](#accessibility-model-a11y-model), states, variants, edge cases, [interaction model](#interaction-model), alternatives considered. | ||
|
|
||
| 2. **Achieve functional consensus.** |
|
|
||
| ## Pull Requests | ||
|
|
||
| Before opening a PR: |
There was a problem hiding this comment.
| Before opening a PR: | |
| Before writing any code: |
2 participants
Adds a contributing guide and proposed templates for bug report, proposal and rfc.