docs(CONTRIBUTING.md): Clarify contribution process - #195
Conversation
Clarify contribution process related to using the project board, labels, creating issues, and adding less/sass files.
serenamarie125
left a comment
serenamarie125
left a comment
There was a problem hiding this comment.
@jgiardino you've done a great job with this. I have a few minor questions/suggestions.
|
|
||
| 1. If the component does not yet exist as a PatternFly component, check the [PatternFly Decision Tree](https://github.com/patternfly/patternfly-design/blob/master/resources/decision-tree/PatternflyDecisionTree.pdf) to see if your component meets the criteria for an addition to PatternFly. If you're unsure, reach out to us on the [email protected] mailing list. | ||
| 2. If the component exists in PatternFly or passes the Decision Tree, then create an issue with the following details: | ||
| 1. Assign the label `enhancement` to the issue |
|
|
||
| To create an issue for adding a new component to the repo, please observe the following process: | ||
|
|
||
| 1. If the component does not yet exist as a PatternFly component, check the [PatternFly Decision Tree](https://github.com/patternfly/patternfly-design/blob/master/resources/decision-tree/PatternflyDecisionTree.pdf) to see if your component meets the criteria for an addition to PatternFly. If you're unsure, reach out to us on the [email protected] mailing list. |
There was a problem hiding this comment.
@jgiardino trying to figure out what this means ... is this implementation of something which is not yet a documented PatternFly design pattern?
There was a problem hiding this comment.
Yes — components that don't exist yet in patternfly core could be added to patternfly react assuming they pass the pf decision tree, so that these contributions aren't blocked.
| 2. If the component exists in PatternFly or passes the Decision Tree, then create an issue with the following details: | ||
| 1. Assign the label `enhancement` to the issue | ||
| 2. Include the text “Component -“ in the beginning of the title if the issue captures a new component | ||
| 3. If the component currently exists in patternfly, include a link to it. |
There was a problem hiding this comment.
Could we reword this to
If the component is documented as a PatternFly Pattern Library, include a link to it.
|
@jgiardino this looks good to me and agree w/ @serenamarie125 's comments. I made a few slight tweaks to the PR template in #101, but it looks like those are already covered in this last section of this contribution guide - "Please be sure to include all of the following in your PR:". The PR template now has similar language which hopefully helps new contributors deploy their storybook correctly. |
Also fix formatting issues
|
@jeff-phillips-18 I updated the section "Adding Styling for your Components." Can you confirm if these updates are accurate? |
|
Hey @serenamarie125, |
|
@serenamarie125 Merged this PR, if you have any further issues/suggestions please open a new issue. |
4 participants
Clarify contribution process related to using the project board, labels, creating issues, and adding
less/sass files.
What: Updates CONTRIBUTING.md
Link: https://github.com/jgiardino/patternfly-react/blob/contributing/CONTRIBUTING.md