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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-19Lines changed: 2 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,16 +76,9 @@ We use issues to track work items, such as bug reports and feature requests. Iss
76
76
77
77
Our issue tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:
78
78
79
-
-`bug` - A bug is a _demonstrable problem_ that is caused by the code in the repository. Please check if the issue has already been reported before reporting a new bug.
80
-
-`DevX` - Suggest an enhancement to the developer experience (DX). DX enhancements improve experience for those building UIs with PatternFly, but have little to know end user impact.
81
-
-`Feature` - Suggest a new feature for PatternFly. Features augment or impact end user experience and requires design input.
82
79
-`breaking change` - this issue warrants a major release and potentially changes APIs for downstream consumers.
83
-
-`Tech debt` - Improvements to code that do not affect either user or product developers’ experiences.
84
-
-`documentation` - this issue affects documentation only.
85
-
-`css` - this issue affects CSS or has stylistic changes.
86
80
-`good first issue` - Issues that are ideal for new contributors.
87
81
-`wontfix` - The issue is legitimate, but it is not something the team is currently able or willing to fix or implement. Issues with this label may be revisited in the future.
88
-
-`p1`, `p2`, `p3` - These are priority labels.
89
82
90
83
### PR labels
91
84
@@ -96,17 +89,9 @@ Since the components in patternfly-react are based on patternfly, we want to mak
96
89
-`css approved` - The issue has been reviewed and approved by a member of the css team.
97
90
-`ux approved` - The issue has been reviewed and approved by a member of the ux team.
98
91
99
-
### Project board columns
92
+
### Integration with Jira
100
93
101
-
The project board uses the following columns to track issues:
102
-
103
-
-`Backlog` - Issues that are ready to be worked and available for any contributor to take.
104
-
-`Needs info` - Issues that require any work that would be completed outside of this repo related to css, design or research. For example some component contributions will require updates to css in the core [patternfly](https://github.com/patternfly/patternfly) repo.
105
-
-`Not started` - Issues that are ready to be worked and are already assigned.
106
-
-`In Progress` - Issues that are actively being worked.
107
-
-`PR in Review` - Issues for which a PR is open and are ready for review.
108
-
109
-
Issues can be manually added to the project board from either the issue page or the project board page.
94
+
We sync our issues to PatternFly's private Jira board. Once an issue is sync'd, a link is added to the issue description in GitHub if someone were to want to track the Jira ticket. Any issue can be assigned an assignee in GitHub or Jira and that information will be sync'd. If an issue is closed in Jira, it will also be closed in GitHub.
110
95
111
96
## Contribution process
112
97
@@ -118,15 +103,13 @@ If you find a bug within the repo, please help us track the issue by following t
118
103
- If it does exist, but doesn’t capture key details that you have noticed, please add a comment to the existing bug.
119
104
2. Create an issue if one doesn’t already exist.
120
105
- Provide details like what component is affected, steps to reproduce, and any other information that is critical to addressing the issue
121
-
- Assign the label “bug” to the issue
122
106
123
107
### Creating issues for new components
124
108
125
109
To create an issue for adding a new component to the repo, please observe the following process:
126
110
127
111
1. If the component does not yet exist as a PatternFly component, please do not start coding yet. Components contributed to PatternFly-React should have a design pattern in PatternFly or be approved PatternFly-Extension components.
128
112
2. If the component exists in PatternFly core (meaning CSS and the pattern design exists), then create an issue with the following details:
129
-
- Assign the label `enhancement` to the issue
130
113
- Include the text “Component -“ in the beginning of the title if the issue captures a new component
131
114
- If the component is documented as a [PatternFly library pattern](http://www.patternfly.org/pattern-library/), include a link to it.
132
115
3. If a component is not in PatternFly, but you feel it would be a good addition to the library, please do the following:
0 commit comments