Skip to content

Commit f8bc60b

Browse files
Update CONTRIBUTING.md
1 parent 40516cd commit f8bc60b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ We'll review your code, suggest any needed changes, and merge it in. Thank you.
1717

1818
## Concepts and Best Practices
1919

20-
- <a name="not-bootstrap" href="#not-bootstrap">#</a> This project is not Bootstrap. The primary audience for this project is software engineers. Yes, contributors should overdocument and explain as much as you can, but you do not need to have components just work when you drop them on the page. New components should always start out as controlled by their parent and only be uncontrolled if a use case presents itself. Think of this project as SLDS templates with minimal logic that happen to work with the React framework.
20+
- <a name="not-bootstrap" href="#not-bootstrap">#</a> This project is not Bootstrap. The primary audience for this project is software engineers. Yes, contributors should over-document and explain as you need to, but you do not need to have components just work when you drop them on the page. New components should always start out as controlled by their parent and only be uncontrolled (that is have state) if a use case presents itself. In short, it's better to have a component that needs 20 props set and outputs the correct SLDS markup, than to have a component that works with no props set. Think of this project as SLDS templates with minimal logic that happen to work with the React framework.
2121
- <a name="approved-slds-patterns" href="#approved-slds-patterns">#</a> This library should include only components which have approved patterns in SLDS. If there is a use case from a designer that conforms to an SLDS pattern, that component should be able to be implemented with this library.
2222
- <a name="controlled-component" href="#controlled-component">#</a> Know what a [controlled component](#understanding-controlled-and-uncontrolled-components) is.
2323
- <a name="familiarize" href="#familiarize">#</a> Familiarize yourself with concepts used in the rest of the library.

0 commit comments

Comments
 (0)