You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Please do not open issues or pull requests regarding the code in React or
24
25
Bootstrap (open them in their respective repositories).
25
26
@@ -68,11 +69,52 @@ doesn't make sense to do this, then it doesn't make sense to use `[changed]` or
68
69
`[removed]` :). For further reading on writing a well formed commit message,
69
70
check out these [5 useful tips for a better commit message][commit-message]
70
71
72
+
### Using `[changed]` with development dependencies updates
73
+
74
+
Use `[changed]` if dev-dependency has impact on the resulting code or API.
75
+
`babel` is a good example of such dev-dependency.
76
+
`chai`, `colors`, `express` or `eslint` are good examples when there is
77
+
no need to add `[changed]`.
78
+
79
+
## Visual Changes
80
+
81
+
When making a visual change, if at all feasible please provide screenshots
82
+
and/or screencasts of the proposed change. This will help us to understand the
83
+
desired change easier.
84
+
71
85
## Docs
72
86
73
87
Please update the docs with any API changes, the code and docs should always be
74
88
in sync.
75
89
90
+
Component prop documentation is generated automatically from the React components
91
+
and their leading comments. Please make sure to provide comments for any `propTypes` you add
92
+
or change in a Component.
93
+
94
+
```js
95
+
propTypes: {
96
+
/**
97
+
* Sets the visibility of the Component
98
+
*/
99
+
show:React.PropTypes.bool,
100
+
101
+
/**
102
+
* A callback fired when the visibility changes
103
+
* @type{func}
104
+
* @required
105
+
*/
106
+
onHide: myCustomPropType
107
+
}
108
+
```
109
+
110
+
There are a few caveats to this format that differ from conventional JSDoc comments.
111
+
112
+
- Only specific doclets (the @ things) should be used, and only when the data cannot be parsed from the component itself
113
+
-`@type`: Override the "type", use the same names as the default React PropTypes: string, func, bool, number, object. You can express enum and oneOfType types, Like `{("optionA"|"optionB")}`.
114
+
-`@required`: to mark a prop as required (use the normal React isRequired if possible)
115
+
-`@private`: Will hide the prop in the documentation
116
+
- All description text should be above the doclets.
117
+
76
118
## Implement additional components and features
77
119
78
120
This project is seeking parity with the core Bootstrap library.
0 commit comments